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

Update docs to use more recent sphinx blueprint #676

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

ijnek
Copy link
Member

@ijnek ijnek commented Jun 7, 2022

Updates the docs to use a more recent sphinx blueprint, since the current one is 9 years old.

  • removes the version evaluation done in conf.py. I think this isn't needed since RTD can figure this out using the git tags in the repo.
  • Adds sphinx-rtd-theme to requirements.txt, rather than using logic to figure out if we're on RTD or not. Maybe we could add instructions to install the reuiqrements.txt for anyone working on the docs, to the root README.rst.
  • Gets rid of /home/user/bloom/docs/glossary.rst: WARNING: document isn't included in any toctree, by commenting out html_static_path in conf.py
  • Extracts the general description of bloom out of index.rst into bloom.rst, so it displays in the sidebar table of contents correctly.

ijnek added 4 commits June 7, 2022 17:51
Signed-off-by: Kenji Brameld <kenjibrameld@gmail.com>
…ebar toc. Having it in index.rst makes it not show up in the sidebar.

Signed-off-by: Kenji Brameld <kenjibrameld@gmail.com>
Signed-off-by: Kenji Brameld <kenjibrameld@gmail.com>
Signed-off-by: Kenji Brameld <kenjibrameld@gmail.com>
@ijnek
Copy link
Member Author

ijnek commented Aug 20, 2022

Gentle ping.

@ijnek
Copy link
Member Author

ijnek commented Dec 9, 2022

@nuclearsandwich Would you be able to give thoughts on this when you find some time? Thanks!

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.

1 participant