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

Change the pyk API docs theme #4451

Merged
merged 2 commits into from
Jun 21, 2024
Merged

Change the pyk API docs theme #4451

merged 2 commits into from
Jun 21, 2024

Conversation

tothtamas28
Copy link
Contributor

@tothtamas28 tothtamas28 commented Jun 18, 2024

Changes the Sphinx theme from alabaster to sphinx_rtd_theme, i.e. Read the Docs.

To check the generated docs under the new theme, run make docs in the pyk directory, then open docs/build/index.html in a web browser.

@tothtamas28
Copy link
Contributor Author

Old theme:

image

@tothtamas28
Copy link
Contributor Author

New theme:

image

@tothtamas28
Copy link
Contributor Author

tothtamas28 commented Jun 18, 2024

In case someone would like to pick another theme, here's a page that demos some themes available in Sphinx: https://sphinx-themes.readthedocs.io/en/latest/

For me, the most important aspect is how well apidoc sections can be visually separated from each other, e.g. one function signature from the next. In my opinion, Read the Docs looks pretty good in that regard: https://sphinx-themes.readthedocs.io/en/latest/sample-sites/sphinx-rtd-theme/kitchen-sink/api/.

@tothtamas28 tothtamas28 self-assigned this Jun 18, 2024
@tothtamas28 tothtamas28 marked this pull request as ready for review June 18, 2024 15:44
Copy link
Contributor

@Baltoli Baltoli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, I think this is definitely an improvement. RTD is pretty standard for Python projects in my experience

@tothtamas28 tothtamas28 merged commit e90afe0 into develop Jun 21, 2024
17 checks passed
@tothtamas28 tothtamas28 deleted the change-sphinx-theme branch June 21, 2024 22:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants