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 documentation theme to sphinx-book-theme #92

Merged
merged 1 commit into from Oct 16, 2021
Merged

Conversation

leouieda
Copy link
Member

Bump up the pinned version of sphinx and the theme. Copy the
configuration and format from Pooch but no major structural changes to
the docs.

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.

Bump up the pinned version of sphinx and the theme. Copy the
configuration and format from Pooch but no major structural changes to
the docs.
@leouieda
Copy link
Member Author

Heads up @LL-Geo @santisoler @MGomezN this means that you will probably want to remove your conda environments and recreate them with the new dependencies for building the docs.

@leouieda leouieda merged commit 98e8503 into master Oct 16, 2021
@leouieda leouieda deleted the docs-theme branch October 16, 2021 07:07
@leouieda
Copy link
Member Author

Related to fatiando/community#35

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.

None yet

1 participant