Paddocs

Paddocs is a module for PADS which self generates documentation from code into a technical manual, blog, info, and man pages. This documentation was generated using the same library. The manuscript, assets, etc are located at ~/docs/paddocs~. Write the documentation within the programs files using the headers outlined in [Notes](#notes-1). Build the documentation with -B, then generate the docs with -G. You can also use paddocs` to generate report templates, metadata for the book, covers, bibliography info. etc.

• Repo: https://github.com/padsRepo/pads
• Blog: https://padsrepo.github.io/pads/
• Docs: https://github.com/padsRepo/pads/wiki

Before you start

Before you begin, make sure you meet these prerequisites:

• Bash >= 5.2
• Pandoc >= 3.4
• Texlive >= 2025.2-2
• Texlive-bibtexextra >= 2025.2-2
• Texlive-context >= 2025.2-2
• Texlive-fontsextra >= 2025.2-2
• Texlive-fontsrecommended >= 2025.2-2
• Texlive-fontutils >= 2025.2-2
• Texlive-formatsextra >= 2025.2-2
• Texlive-latex >= 2025.2-2
• Texlive-latexextra >= 2025.2-2
• Texlive-latexrecommended >= 2025.2-2
• Texlive-luatex >= 2025.2-2
• TTF-Hack
• TTF-Nerd-Fonts-Symbols
• man-pages
• man-db

Get started

1. Download:

    $ git clone https://github.com/padsRepo/paddocs

2. Install:

    $ makepkg -si

What's next

1. Build the book:

   $ paddocs -b book && paddocs -b metadata

2. Copy and paste the headers outlined in Notes to your bash command.

   • Fill in what you need
   • You don't have to use all of them

3. Build the documentation. This will generate a new chapter under the manuscript/10-technical section, and copy the schemas from `assets/schemas/10-technical. Then build the documentation from the headers you use:

   $ paddocs -B -d mycmd

4. Generate a full report in the selected format to ~/docs/paddocs/output/chapters/mycmd.md:

   $ paddocs -G -c 10 mycmd html

OR optionally include a directory to save to

   $ paddocs -G -c 10 mycmd html mycmd/docs/page

5. View it in the browser:

   $ paddocs -s
   $ http://127.0.0.1:8000

Examples:

paddocs -h
: Show the help menu and exit

paddocs -v
: Show the version and exit

paddocs -Mr shcmd
: Make a README file for the given command. The default output is to the terminal.

paddocs -B -s <section> : Build a new section for the book. It will generate a directory under manuscript and schemas to start building templates. It will also make the initial metadata.yaml, cover.md files.

paddocs -B -c <schema> <name>
: Build the technical report for from paddocs/assets/schemas/<schema> into the paddocs/manuscript/10-technical/\<name\> directory. This is if you need more of a full technical report.

paddocs -B -d <name>
: Build the technical report for from paddocs/assets/schemas/10-technical into the paddocs/manuscript/10-technical/\<name\> directory. This assumes it is a technical report and nothing else. This will automatically create the chapter if it does not exist.

paddocs -B -m <name>
: Build the man page for into the paddocs/manuscript/11-manual directory. This is a page for the man command.

paddocs -G -w <name>
: Generate a wiki style report for . This is saved to <name>/docs/wiki

paddocs -G -b <suffix>
: Generate a compendium of the entire manuscript/ directory to output/book/compendium.<suffix>. The is the format to convert to, can be html, or pdf.

paddocs -G -c <section> <name> <suffix> [dir]
: Generate a Chapter from a Section to output/chapters/<name>.<suffix>. The is the format to convert to, can be html, or pdf.

Troubleshooting:

1 | turn it off and on again 2 | blow on it 3 | say 3 hail mary's

Contributing:

1. Fork the repo
2. Create a feature branch (git checkout -b feature-name)
3. Commit changes (git commit -m "Add feature")
4. Push branch (git push origin feature-name)
5. Open a Pull Request