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

More revisions #29

Merged
merged 5 commits into from
Dec 5, 2021
Merged

More revisions #29

merged 5 commits into from
Dec 5, 2021

Conversation

2bndy5
Copy link
Collaborator

@2bndy5 2bndy5 commented Dec 3, 2021

  • resolves version selector working? #20 by revising the "Version Dropdown" docs
    • docs also now demonstrate the version dropdown selector by offering "ReadTheDocs" version and "Github Pages" version.
  • fixes "language" parameter missing in docs, build fails when there's none in conf.py #23 by making English the default language if language option was not specified in conf.py
  • implements suggestions from No article TOC/index scrolling for Python elements #25
    • revises docs about palette option
    • uses favicon_url and logo_url introduced in sphinx 4.0 (& recommended as favicon/logo are now deprecated)
    • removes some confusing config options like
      • globaltoc_includehidden (internally defaults to True)
      • globaltoc_depth (internally set to -1 by default)
  • addresses font instead of fonts in docs #28 and removes doc artifacts from sphinx-material theme, namely font & font_icon
    • added font option to html_theme_options docs. This includes an example snippet & a link to valid font faces
  • tweaked some other things in the docs' customization page while I was proofreading and adding example snippets.

- resolves jbms#20
- fixes jbms#23
- implements suggestions from jbms#25 and removes some confusing config options
- addresses jbms#28 and removes artifacts from sphinx-material theme
docs/conf.py Outdated Show resolved Hide resolved
docs/customization.rst Outdated Show resolved Hide resolved
docs/customization.rst Outdated Show resolved Hide resolved
@jbms
Copy link
Owner

jbms commented Dec 4, 2021

Thanks!

docs/customization.rst Outdated Show resolved Hide resolved
@jbms
Copy link
Owner

jbms commented Dec 4, 2021

Thanks, this looks good to me / ready to merge.

@2bndy5
Copy link
Collaborator Author

2bndy5 commented Dec 5, 2021

I should probably mention that I make it a point to not merge my own PRs (unless I'm the only maintainer). If you think it's ready to merge, you can take co-authorship credit by squash-n-merging it.

@jbms jbms merged commit 1597b3e into jbms:main Dec 5, 2021
@2bndy5 2bndy5 deleted the more-revisions branch December 5, 2021 09:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants