-
Notifications
You must be signed in to change notification settings - Fork 55
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
Docs update #260
Docs update #260
Conversation
…hange later once reorganization is complete
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a partial review for just the content and doc strings. I'll look at the structural RTD changes later. Thanks for doing all of this!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall, this looks really good! I pointed out some typos and made a few suggestions.
Co-authored-by: Heather Craker <[email protected]>
Co-authored-by: Heather Craker <[email protected]>
Co-authored-by: Heather Craker <[email protected]>
Co-authored-by: Heather Craker <[email protected]>
Co-authored-by: Heather Craker <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great! Thank you so much!
See #245
This is a big one, sorry y'all. I've tried to make a comprehensive summary and explanation of all the changes.
Summary of changes
Structural
build_envs/docs.yml
) used for doc generationpost_create_environment
step in.readthedocs.yml
to circumvent default eager pip dependency update and maintain f2py namespace inclusion for docsdocs/_static/style.css
anddocs/_static/theme_overrides.css
, both included indocs/conf.py
)docs/_static/images/logos/GeoCAT_square.svg
as a favicon instead of default RTD logonb_execution_mode = "off"
in `conf.py, allows (only, for the time being) pre-rendered notebooks. Theoretically the "auto" setting would already allow this with notebooks where all cells are run, but that is not behaving as expected and is something to look into in UMBRELLA ISSUE: Migration of geocat-comp examples to this repository from geocat-examples #258Content
update_gallery()
function added todocs/conf.py
docs/notebook_examples.txt
, created when docs are generated, added to.gitignore
docs/gallery.yml
added. Used byupdate_gallery()
to generatenotebook_examples.txt
docs/citation.rst
,docs/index.rst
,docs/examples.rst
)Formatting
conf.py
to allow for easier type linking in docstrings (ie not having to do :class:`int` or similar anymore)