Deployment of documentation to Github Pages

weso / hercules-sync

Tools to synchronise data between the ontology files and Wikibase instance for the Hercules project at University of Murcia.

GNU General Public License v3.0

4 stars 1 forks source link

Deployment of documentation to Github Pages #10

Closed alejgh closed 4 years ago

alejgh commented 4 years ago

Some remarks:

Documentation should follow the arc42 markdown template.
Markdown files should be converted to html and a custom style should be added to the final page.
This deployment should be added to CI.

I think sphinx should be used for this task, since it can work with markdown and we could easily generate automatic documentation from our Python docstrings in the future.

alejgh commented 4 years ago

This has already been implemented in #12 and I forgot to close the issue.

Documentation is available in http://www.weso.es/hercules-sync/. I will add it to the README.