STYLE: Make doc module consistent with Sphinx conventions #204
Conversation
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
jhlegarreta
force-pushed
the
IncreaseDocModuleConsistency
branch
from
ffae273 to
b5360f3
Compare
|
Will need to be rebased after PR #180 and the GHA workflow file be adapted: |
jhlegarreta
force-pushed
the
IncreaseDocModuleConsistency
branch
2 times, most recently
from
8f2512b to
96a67dc
Compare
jhlegarreta
force-pushed
the
IncreaseDocModuleConsistency
branch
2 times, most recently
from
ee9f246 to
a92893c
Compare
jhlegarreta
force-pushed
the
IncreaseDocModuleConsistency
branch
from
a92893c to
b49655a
Compare
jhlegarreta
force-pushed
the
IncreaseDocModuleConsistency
branch
8 times, most recently
from
7ca7d0b to
8cb404b
Compare
Make the documentation module consistent with Sphinx conventions: - Rename the module to `docs`. - Host the configuration file and index file in `docs/sources`. Change the makefile `SOURCEDIR` variable accordingly. - Change accordingly the `sphinx-apidoc` command output path argument, and the configuration file location in the `.readthedocs.yaml` config file. - Change the relative paths to the files in the `_static` folder. - Move the Markdown bundle naming and tutorial files and the associated screenshots to the `docs/sources` folder so that all files can be recursively included from the source directory.
jhlegarreta
force-pushed
the
IncreaseDocModuleConsistency
branch
from
8cb404b to
09682e7
Compare
ljod
approved these changes
Dec 7, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Make the documentation module consistent with Sphinx conventions:
docs.docs/sources. Change the makefileSOURCEDIRvariable accordingly.sphinx-apidoccommand output path argument, and the configuration file location in the.readthedocs.yamlconfig file._staticfolder.docs/sourcesfolder so that all files can be recursively included from the source directory.