Skip to content

Commit dc82024

Browse files
authored
Update documentation for hosting (#6)
* update instructions to build documentation locally only * install PyEarthTools packages too for document generation * use conda to install dependencies to generate the documentation * fix doc generation + reindent mkdocs.yml to be consistent - fix generation script - fix options of mkdocstrings - update path of packages to list * move EDIT 101 content, add warnings about documentation state * remove large (37 MB) gif from docs assets * add disclaimer about documentation audience * move old documentation out of packages as it is not a Python package * add warning about state of the docs * update path to Python packages for document generation * fix (again) path to packages for doc generation * back to instructions using a virtual environment for doc generation This makes it simpler to have the same installation process for manual installation and CI. * add CI to build the documentation * remove unused setting * fix path for doc generator script * Update docs.yml change branch used to generated the documentation in CI/CD. * removed github pages automation
1 parent d7a4a10 commit dc82024

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+100
-88
lines changed

old_docs/README.md

Lines changed: 33 additions & 0 deletions
File renamed without changes.
File renamed without changes.
File renamed without changes.

packages/documentation/docs/documentation/data/Developing Your Own/dataflow.md renamed to old_docs/docs/documentation/data/Developing Your Own/dataflow.md

packages/documentation/docs/documentation/data/Developing Your Own/decorators.md renamed to old_docs/docs/documentation/data/Developing Your Own/decorators.md

packages/documentation/docs/documentation/data/Developing Your Own/extend.md renamed to old_docs/docs/documentation/data/Developing Your Own/extend.md

0 commit comments

Comments
 (0)