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

Switch to the sphinx-book-theme #343

Merged
merged 26 commits into from
Dec 14, 2021
Merged

Switch to the sphinx-book-theme #343

merged 26 commits into from
Dec 14, 2021

Conversation

leouieda
Copy link
Member

@leouieda leouieda commented Dec 14, 2021

This is the theme being used by all our other projects. It's more modern and removes the need for some of the templating hacks that we had with the RTD theme. Updates the theme but not the format of the documentation.

Related to fatiando/community#35

Reminders:

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst and the base __init__.py file for the package.
  • Write detailed docstrings for all functions/classes/methods. It often helps to design better code if you write the docstrings first.
  • If adding new functionality, add an example to the docstring, gallery, and/or tutorials.
  • Add your full name, affiliation, and ORCID (optional) to the AUTHORS.md file (if you haven't already) in case you'd like to be listed as an author on the Zenodo archive of the next release.

@leouieda leouieda marked this pull request as ready for review December 14, 2021 13:30
@leouieda leouieda merged commit 95c3f5a into main Dec 14, 2021
@leouieda leouieda deleted the sphinxbooktheme branch December 14, 2021 13:41
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