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

[feat] Convert the documentation to Read The Docs template #1426

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

Conversation

dhunstack
Copy link
Contributor

Following changes were made in this commit -

  • Sphinx's conf.py file was regenerated. Old configuration file is in conf_old.py
  • custom.css was added to set sidebar colors
  • documentation.rst page was added to serve as the home page for docs. Replaces the old documentation.html.
  • Some rst files were modified to reduce the number of sidebar pages
Screenshot 2024-07-01 at 16 02 40 Screenshot 2024-07-01 at 16 05 43

@dhunstack dhunstack force-pushed the rtd_final branch 2 times, most recently from 86097fc to e54fd81 Compare July 1, 2024 15:43
@dhunstack dhunstack force-pushed the rtd_final branch 4 times, most recently from a760029 to 5f3b3fe Compare October 10, 2024 23:11
@dbogdanov
Copy link
Member

@dhunstack The build-docs workflows is missing sphinx_rtd_theme dependency (Theme error: no theme named 'sphinx_rtd_theme' found (missing theme.toml?)), it needs to be added here.

@dbogdanov
Copy link
Member

Fixed doc build script to catch such issues in the future: c896c90.

@dhunstack dhunstack force-pushed the rtd_final branch 2 times, most recently from 0b41b58 to dee94bd Compare October 17, 2024 12:11
Following changes were made in this commit -
 - Sphinx's `conf.py` file was regenerated. Old configuration file is in `conf_old.py`
 - `custom.css` was added to set sidebar colors
 - `documentation.rst` page was added to serve as the home page for docs. Replaces the old `documentation.html`.
 - Some `rst` files were modified to reduce the number of sidebar pages

Signed-off-by: Anmol Mishra <[email protected]>
@dhunstack
Copy link
Contributor Author

PR for dependency updates - #1444
Can merge that in master first to avoid creating another merge commit here.

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