Skip to content

GeoCat documentation themes for Sphinx, Hieroglyph, DocBook, Jekyll and more!

License

Notifications You must be signed in to change notification settings

GeoCat/geocat-themes

Repository files navigation

geocat-themes

GeoCat documentation themes for Sphinx, Hieroglyph, DocBook, Jekyll and more!

example: document used to test geocat_rtd theme

  • Provides a handy writing guide for GeoCat products, training and presentations.
  • Covers guidence for contributing sphinx documentation to GeoNetwork and GeoServer communities.
  • Published as GitHub pages: https://geocat.github.io/geocat-themes/

example_slides: slide example testing geocat_slides theme

sphinx-build environment

Tested with the following managed by requirements.txt:

macOS:

brew install python
pip3 install -r requirements.txt

windows:

pip3 install -r requirements.txt

jenkins:

update github pages

cd example
mvn clean deploy
git add ../docs
git commit -m "update docs"
git push

update sphinx_rtd_theme

The geocat_rtd theme extends sphinx_rtd_theme.

With each sphinx_rtd_theme update some testing may be required. Have a look at the changelog, and double check if any fixes need to be applied to geocat_rtd theme. Comparing files changed between tags helps:

  • breadcrumbs.html

    The GeoCat theme is a copy with <!-- link to GeoCat docs home --> section added

  • footer.html

    GeoCat theme is a clean extension forcing show_sphinx false.

Test using example:

cd example
ant clean
ant

About

GeoCat documentation themes for Sphinx, Hieroglyph, DocBook, Jekyll and more!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published