Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BUG: Fix Sphinx documentation configuration file #136

Merged
merged 2 commits into from
Mar 19, 2024

Commits on Mar 18, 2024

  1. BUG: Specify the language 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
    ```
    jhlegarreta committed Mar 18, 2024
    Configuration menu
    Copy the full SHA
    8912300 View commit details
    Browse the repository at this point in the history
  2. BUG: Fix DIPY doc URL in Sphinx documentation config file

    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 committed Mar 18, 2024
    Configuration menu
    Copy the full SHA
    59a8b34 View commit details
    Browse the repository at this point in the history