The documentation of BlocksDS is built with Hugo. The theme used is Geekdoc.

The documentation of the libraries included in BlocksDS is built with Doxygen.

• Hugo

  Follow the installation guide. You need the extended version of Hugo.

• Hextra

  Download the theme by cloning the repository in themes/hextra:

  cd themes
  git clone https://github.com/imfing/hextra --depth=1

If you have made some change to the documentation and want to check the output locally, simply run the following command from the docs folder:

hugo server

That command will print a URL that you can open from a browser to see the results.

You can also run the following command to only generate the static website without a web server:

hugo

Install Doxygen. Then, go to the root of each one of the libraries (libnds, dswifi, etc) and run:

make docs

The output will be generated in the docs/html folder.

The script build-docs.sh downloads the theme and builds the documentation of all repositories of BlocksDS. Note that this sets the base URL of the documentation to https://blocksds.skylyrac.net/, so this script isn't useful for non-maintainers. This script is used by the GitHub Actions workflow of the following repository: https://codeberg.org/blocksds/docs