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

Redesign of the docs #391

Merged
merged 34 commits into from
Oct 22, 2024
Merged

Redesign of the docs #391

merged 34 commits into from
Oct 22, 2024

Conversation

astrofle
Copy link
Collaborator

@astrofle astrofle commented Sep 25, 2024

This PR changes the outline of the documentation, splitting the contents into four main categories: tutorials, how-to guides, explanation material and reference material.

One downside of the current implementation is that the example notebooks are symlinked twice, one for tutorials and one for how-to guides, which means all notebooks get executed twice 👎

To try it out (assuming you have sphinx>=7.3). From the dysh root dir:

sphinx-build docs/source docs/build -b html --fresh-env
sphinx-autobuild docs/source docs/build -b html --host=`hostname` --port=<xxxx>

then navigate to `hostname`:<xxxx> to see the docs (assuming you are in the same network as `hostname`).

I'd also recommend changing this line in docs/source/conf.py for testing (don't commit that change. I do not know what that would do to the ReadTheDocs build):

nb_execution_mode = "cache"

to

nb_execution_mode = "auto"

this avoids executing the notebooks multiple times.

If you find anything missing or any errors, please leave a comment/review.

@astrofle astrofle marked this pull request as draft September 25, 2024 16:48
@astrofle astrofle marked this pull request as ready for review September 25, 2024 18:22
@astrofle astrofle requested a review from etsmit September 25, 2024 18:23
@astrofle astrofle merged commit 7ba4daf into main Oct 22, 2024
14 checks passed
@astrofle astrofle deleted the docs-redesign-gbtdocs branch October 22, 2024 16:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants