gendoc

This is a tool to generate the docs for all packages in the Dylan package catalog. How it works, in a nutshell:

• Load the package catalog.
• Download each package to a temp directory.
• Copy package ResTructured Text docs into a combined directory tree.
• Modify docs/source/index.rst to list each package in the top-level toctree directive.

Note

The "docs" subdirectory in this repository is intentionally not named "documentation" in order to prevent gendoc itself from showing up in the package catalog since it has no documentation other than this README. Eventually we should have a setting in dylan-package.json to exclude the package from combined docs.

Usage

To generate package docs in the docs/source directory:

.. code-block:: shell

$ git clone https://github.com/dylan-lang/gendoc $ cd gendoc $ dylan update $ dylan build -a $ _build/bin/gendoc --excludes-file exclude-list.txt docs/source/index.rst $ cd docs $ make html $ rsync -av _build/html/ /var/www/package.opendylan.org/