Documentation improvements

hpcflow / hpcflow-new

Mozilla Public License 2.0

0 stars 5 forks source link

Documentation improvements #699

Closed dkfellows closed 2 months ago

dkfellows commented 4 months ago

Working on improving documentation.

[x] CI building of docs (or at least the Sphinx part)
[x] Fix errors in doc build
[x] Add missing method docs

There's still some places where things are double-linked. Those are quite tricky to hunt down when they're in the output of autodoc.

dkfellows commented 3 months ago

That's all the remaining faults that I can fix. The ones that are left (all warnings) are due to the combination of importing the cli stuff from hpcflow.sdk into hpcflow.app and the CLI documentation being generated by click; the place where it's going wrong is just too deep within the nest of generated stuff.