This repository was archived by the owner on Jan 27, 2025. It is now read-only.
BUG: Fix Sphinx documentation configuration file #136
Merged
Conversation
This file contains hidden or 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
Collaborator
jhlegarreta
commented
Mar 18, 2024
jhlegarreta
commented
- BUG: Specify the language in Sphinx documentation config file
- BUG: Fix DIPY doc URL in Sphinx documentation config file
Specify the language in Sphinx documentation config file.
Fixes:
```
Running Sphinx v7.2.6
Warning, treated as error:
Invalid configuration value found: 'language = None'.
Update your configuration to a valid language code.
Falling back to 'en' (English).
make: *** [Makefile:65: html] Error 2
```
raised when running:
```
make -C docs/ SPHINXOPTS="-W" BUILDDIR="$HOME/docs" OUTDIR="${CURBRANCH:-html}" html
```
Fix DIPY doc URL in Sphinx documentation config file: the URL was changed starting DIPY 1.8.0. Fixes: ``` Warning, treated as error: failed to reach any of the inventories with the following issues: intersphinx inventory 'https://dipy.org/documentation/latest/objects.inv' not fetchable due to <class 'requests.exceptions.HTTPError'>: 404 Client Error: Not Found for url: https://dipy.org/documentation/latest/objects.inv make: *** [Makefile:65: html] Error 2 ``` raised when running: ``` make -C docs/ SPHINXOPTS="-W" BUILDDIR="$HOME/docs" OUTDIR="${CURBRANCH:-html}" html ```
jhlegarreta
commented
Mar 18, 2024
|
|
||
| # Example configuration for intersphinx: refer to the Python standard library. | ||
| intersphinx_mapping = { | ||
| "bids": ("https://bids-standard.github.io/pybids/", None), |
There was a problem hiding this comment.
All versions pointed here should probably be synchronized with the versions specified when listing the dependencies, but that is a separate issue/PR.
jhlegarreta
changed the title
|
BTW, the and I had to call Not sure if skipping that step was intentional. The call will change anyways after #128. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.