Add documentation to repositories
Follow the file scheme at https://gitlab.eox.at/vs/preprocessor-v3
Notable adding, copying, overwriting:
- requirements-docs.txt needs to be copied
- .gitlab-ci.yml pages section should be copied over, the image should be the same as for testing
- docs folder should be copied and adapted
- docs/api folder is autogenerated by make html and shouldn't be copied
- configuration.rst shouldn't be copied
- CHANGELOG.rst should be initialized to the next minor version and contain only information relating to documentation
- populate with the next version number and basic added changelog and documentation
- conf.py should be updated
- module_dir needs to point to the code (e.g "../harvester")
- project needs to be updated
- update author, set yourself
=========
Changelog
=========
Version 2.1.10 <- figure out what the next patch version is, this is for harvester
=============
- Added changelog
- Added docs
- AUTHORS.rst should be filled with all authors contributing to the repo
- populate with authors of the repository
Confirm that documentation available after running make html
. The files will be available in the _build
directory. Confirm that the api folder is created and index.html should look like web page below
The generated docs should resemble the docs here: https://vs.pages.eox.at/preprocessor-v3/