Add Readthedoc feature #15
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| version: "2" | ||
|
|
||
| build: | ||
| os: "ubuntu-22.04" | ||
| tools: | ||
| python: "3.12" | ||
| jobs: | ||
| post_install: | ||
| - curl -fsSL https://pixi.sh/install.sh | bash | ||
| - export PATH="$HOME/.pixi/bin:$PATH" && pixi install | ||
| - pixi shell -c "pixi install && sphinx-build -T -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html" | ||
| sphinx: | ||
| builder: html | ||
| configuration: docs/conf.py | ||
| fail_on_warning: true | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| #!/bin/sh | ||
|
There was a problem hiding this comment. This file can be removed, right? There was a problem hiding this comment. yup originally just testing |
||
| . $(pixi shell --quiet) | ||
| pixi run docnb | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,35 @@ | ||
| project = "GlueX-Nstar" | ||
| author = "ComPWA" | ||
|
|
||
| exclude_patterns = [ | ||
| "**.ipynb_checkpoints", | ||
| ".DS_Store", | ||
| ".pixi", | ||
| "Thumbs.db", | ||
| "_build", | ||
| ] | ||
| extensions = [ | ||
| "myst_nb", | ||
| "sphinx.ext.duration", | ||
| "sphinx.ext.doctest", | ||
| "sphinx.ext.autodoc", | ||
| "sphinx.ext.autosummary", | ||
| "sphinx.ext.intersphinx", | ||
| "sphinx.ext.napoleon", | ||
| "sphinx.ext.viewcode", | ||
| ] | ||
| html_theme = "sphinx_rtd_theme" | ||
|
There was a problem hiding this comment. This theme change is not required on RTD. Also works with what you had before. |
||
| master_doc = "index" | ||
| myst_enable_extensions = [ | ||
shenvitor marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| "colon_fence", | ||
| "deflist", | ||
| "dollarmath", | ||
| "html_admonition", | ||
| "html_image", | ||
| "linkify", | ||
| "substitution", | ||
| "tasklist", | ||
| ] | ||
| nitpicky = True | ||
| nb_execution_mode = "auto" | ||
shenvitor marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| version = "0.1.0" | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -28,12 +28,17 @@ jupyterlab = ">=4.2.0,<4.3" | |
| jupyterlab-git = ">=0.50.0,<0.51" | ||
| jupyterlab-lsp = ">=5.1.0,<5.2" | ||
| jupyterlab-myst = ">=2.4.2,<2.5" | ||
| linkify-it-py = ">=2.0.3,<2.1" | ||
| myst-nb = ">=1.1.0,<1.2" | ||
| myst-parser = ">=3.0.1,<3.1" | ||
| nbsphinx = ">=0.9.4,<0.10" | ||
|
There was a problem hiding this comment. I would use There was a problem hiding this comment. Actually, why are dependency changes required in this PR? There was a problem hiding this comment. I added them when I added RTD from their example |
||
| numpy = ">=1.26.4,<1.27" | ||
| pre-commit = ">=3.7.1,<3.8" | ||
| pydata-sphinx-theme = ">=0.15.2,<0.16" | ||
| python = ">=3.12.3,<3.13" | ||
| python-graphviz = ">=0.20.3,<0.21" | ||
| scipy = ">=1.13.0,<1.14" | ||
| sphinx = ">=7.3.7,<7.4" | ||
| sphinx-autobuild = ">=2024.4.16,<2024.5" | ||
| sphinx_rtd_theme = ">=2.0.0,<2.1" | ||
|
There was a problem hiding this comment. Are you selecting that in |
||
| sympy = ">=1.12,<2" | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unfortunately, RTD runs its own
sphinx-buildcommand (hencepre_build,post_build, not build itself). So just runningpixi shellshould suffice 🤞 If it doesn't, this may be a more tricky issue to solve...There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Btw
pixi installis not needed, at mostpixi shellThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems like it doesn't, maybe tricky? What if the
pixi shellan interactive shell which is not supported in the ReadTheDocs environment, maybe?e.g. this issue in RTD build indicates that it probably can't start an interactive shell there:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
https://readthedocs.org/projects/gluex-nstar/builds/24669635/