Overhaul documentation and use Book theme #600
Merged
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
This enables building the docs locally using the climada_env.
* Load Sphinx extensions for parsing Markdown. * Fix exclude patterns for build directory. * Update project descriptors. * Add logo and favicon to docs. * Switch to Book HTML theme.
* Add subgroups for tutorials. * Add missing tutorials. * Add symlinks to top-level markdown files for including them in the docs.
|
This is how it looks like.
|
* Move symlinks from /doc to /doc/misc. * Add doc/README.md with instructions for building the documentation. * Update installation instructions to include the developer requirement specifications.
|
Great! I would suggest to:
|
* Add step-by-step installation tutorial again. * Add hint for switching versions on Readthedocs. * Fix links on index page.
|
Latest version. Note that the "hint" will only appear on ReadTheDocs, not when building the docs on your local machine.
|
This reverts commit c283a0b.
* Create a Dockerfile for building a pristine conda environment for extracting the doc requirements. * Add instructions on how to use it to doc/README.md. * Add doc/README.md to the Sphinx documentation.
|
@emanuel-schmid Could you give this a look? It's now quite a bit but it resolves three issues at once 💪 You will find the preview here: https://climada-python--600.org.readthedocs.build/en/600/ I already incorporated the suggestions by @chahank. This is ready to go! |
|
🤩 |
This was referenced Dec 12, 2022
11 tasks
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.
Changes proposed in this PR:
doc/README.mdwith instructions on how to build the documentationdoc/create_env_doc.dockerfilefor building the documentation environment from scratchrequirements/env_developer.ymlto theclimada_envThis PR resolves #592 #599 #603
PR Author Checklist
develop)[ ] Tests updatedPR Reviewer Checklist