Docs

Description

Generates the project documentation with pasdoc 1.0 into the docs folder, from the pages in docs/generate and the project sources. It needs pasdoc in the path, for example installed with mise use -g github:pasdoc/pasdoc.

pasc docs

It works by convention:

• docs/generate/introduction.txt is the introduction, and conclusion.txt the conclusion, when they exist.

• Every other docs/generate/*.txt is an additional page. In the menu, the guides come first, then the command*.txt pages under Commands, then the code reference under Reference.

• The sources are the units in the search paths of the project in the current folder, and its main program. At the root of a workspace, of every member. The boss modules are not documented.

• docs/generate/custom.css, when it exists, replaces the pasdoc style.

It exits with code 1 when pasdoc is missing or fails, so it can run in the CI. The pasc site itself is generated by it on GitHub Actions and published to GitHub Pages.

Next Help Command

---

Generated by PasDoc 1.0.4.