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

Docs update #260

Merged
merged 97 commits into from
Oct 6, 2022
Merged

Docs update #260

merged 97 commits into from
Oct 6, 2022

Conversation

anissa111
Copy link
Member

@anissa111 anissa111 commented Oct 4, 2022

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

  • separate environment file (build_envs/docs.yml) used for doc generation
  • geocat-comp (and geocat-f2py) installation removed from settings in RTD and moved to post_create_environment step in .readthedocs.yml to circumvent default eager pip dependency update and maintain f2py namespace inclusion for docs
  • theme change to book theme
  • minor CSS changes for formatting of icons on "cards" on getting started and home page and minor color theming (docs/_static/style.css and docs/_static/theme_overrides.css, both included in docs/conf.py)
  • start usage of docs/_static/images/logos/GeoCAT_square.svg as a favicon instead of default RTD logo
  • switches notebook generation at time of docs generation off with setting nb_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 #258

Content

  • content/toctrees reorganized and removed as html links from all pages
  • NSF text relocated from homepage to footer of all docs pages
  • gallery style examples page
    • update_gallery() function added to docs/conf.py
    • docs/notebook_examples.txt, created when docs are generated, added to .gitignore
    • docs/gallery.yml added. Used by update_gallery() to generate notebook_examples.txt
  • "Getting Started" pages added in Add "Getting Started" section to docs #240 by @hCraker
    • overview page
    • quick install page
    • mini examples page
  • minor (mostly formatting or reorganization) changes for some existing content files (docs/citation.rst, docs/index.rst, docs/examples.rst)
  • removal of use of ncar channel from documentation (also in Add "Getting Started" section to docs #240)
  • adds rough modified first example migrated from geocat-examples, going to be cleaned up with others in UMBRELLA ISSUE: Migration of geocat-comp examples to this repository from geocat-examples #258 (needed at least one example migrated for gallery to work)
  • adds toctree linkage to google forms function request form

Formatting

  • addresses most of the warnings in documentation generation (that aren't coming from geocat-f2py)
    • changes links to anonymous links by switching from `text <link>`_ to `text <link>`__
    • making sure all files are properly linked in toctrees
    • minor docstring changes
  • switched from :code: directive to ticks where appropriate
  • some docstring changes for warning removal or for very obvious formatting issues. Will be more thoroughly addressed in Docstring improvements #259
  • some changes to napoleon settings in conf.py to allow for easier type linking in docstrings (ie not having to do :class:`int` or similar anymore)

@anissa111 anissa111 added documentation Improvements or additions to documentation high priority developer feature For development standardization / best practices / enhancement labels Oct 4, 2022
@anissa111 anissa111 linked an issue Oct 4, 2022 that may be closed by this pull request
10 tasks
Copy link
Contributor

@hCraker hCraker left a 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!

Copy link
Contributor

@hCraker hCraker left a 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.

@anissa111 anissa111 requested a review from hCraker October 5, 2022 21:38
Copy link
Contributor

@hCraker hCraker left a 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!

@anissa111 anissa111 merged commit 45a5cb4 into main Oct 6, 2022
@anissa111 anissa111 deleted the docs branch October 6, 2022 15:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
developer feature For development standardization / best practices / enhancement documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

UMBRELLA ISSUE: Documentation Improvements
2 participants