POD doc generator needs work - Githubissues

openwebwork / docs

Documentation and Help for WeBWorK

4 stars 2 forks source link

POD doc generator needs work #5

Open mgage opened 5 years ago

mgage commented 5 years ago

The output of pod documents has been moved to https://demo.webwork.rochester.edu/wwdocs/ (it can be reached from the webwork wiki author's page). It kind of works, but the script needs work to make the formatting better (e.g. including the parent directory).
The newest code for the POD document generator: is in https://github.com/mgage/admintools/tree/master/pod_doc_tools and in the pull request: https://github.com/openwebwork/admintools/pull/2
The script is currently being hosted on demo.webwork.rochester.edu for the time being. It should be moved to a VM which is controlled by The WeBWorK Project.

taniwallach commented 4 years ago

Once there are generated POD files, they can apparently be hosted on GitHub.

See for example: https://github.com/openwebwork/pg/blob/master/doc/MathObjects/UsingMathObjects.pod

I recommend we consider whether the scripts could be set up to generate POD files and push them to a repo on GitHub instead of generating PDF files for hosting on some VM.

It could be that just the "table of contents" and/or "index" type pages need to be hosted outside GitHub, but probably if they were generated in markdown syntax - they could be on GitHub as .md files.