Optimizing documentation

mgeraeds / hires-processing

Code for processing large files from geospatial and hydrodynamic models.

MIT License

0 stars 0 forks source link

Optimizing documentation #9

Closed rortizmerino closed 5 months ago

rortizmerino commented 5 months ago

So far, just-the-docs was implemented but not actually used. After getting deeper into the project, sphinx seems as a more appropriate alternative. To change implement sphinx, now:

[x] 1. Remove just-the-docs files
[x] 2. Initialize sphinx

A new issue might be opened in case task 1 turns out too complicated

rortizmerino commented 5 months ago

Change has been succesfully implemented. Documentation now is built by sphinx using 'book' theme and it's deployed into the 'gh-pages' branch from 'main'.

'gh-pages' was generated from '9-develop-optimizing-documentation' which will now be deleted.

Happy documenting!