Skip to content

Conversation

@tkknight
Copy link
Contributor

Iris documentation overhaul to use a modern responsive theme and to be served via https://readthedocs.org/. This is the new baseline for future improvements to be made.

  • Added page for contributing to the documentation
  • Adopted sphinx_rtd_theme (responsive to device, standard formatting)
  • Adopted sphinx-copybutton
  • Adopted sphinx-gallery and removed the custom one. Updated references to the new gallery
  • Added "make html-noplot" option to skip the gallery creation (fast when developing)
  • Renamed the examples_code and example_tests to be gallery_code and gallery_tests
  • Prefixed all gallery files with "plot_"
  • Ensured a clean build with no warnings (there were many)
  • Setup to now build by readthedocs (see the config file in the root .readthedocs.yml that uses conda)
  • Added travis test to include "make linkcheck" that checks that all urls are valid - fixed many that were not
  • Updated image on iris github homepage to be better resolution and standard font (Georgia)
  • Build directory now in src directory, named "_build"
  • Remove legacy files from "_static"
  • Sphinx conf.py file has better structure and comments
  • Copyright date range end is now dynamic
  • Various typos and formatting in source
  • API rst builder now show no warnings when run
  • Added link to the "legacy" documentation
  • Put in place a block list for troublesome modules when generating the API documentation
  • Changed "Whitepapers" to "Technical Papers"

@tkknight tkknight changed the title Rtd final Read The Docs documentation Jul 12, 2020
@bjlittle bjlittle self-assigned this Jul 13, 2020
@bjlittle bjlittle added this to the v3.0.0 milestone Jul 13, 2020
Copy link
Member

@bjlittle bjlittle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tkknight Super awesome... thanks for all you effort on this.

Just some minor changes, then we're good to go! 👍

@tkknight
Copy link
Contributor Author

I think this is good to go now.

@bjlittle
Copy link
Member

@tkknight LGTM 👍

Just waiting for travis-ci to do it's thing...

As a follow-up, I can now tackle re-hauling the iris requirements, thanks!

@trexfeathers
Copy link
Contributor

Resolves #3690

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Version wrong in <title> tag in Iris 2.4 documentation

4 participants