To modify the website, look at the RST files in source (you can find
documentation on using ReStructuredText with Sphinx here).
To modify the function contracts, you have to modify the source code of HAL (
bin/lib/py_src for the python contracts, and bin/lib/include for the C++).
To rebuild C++ contracts, run:
doxygen && make html
To just build the RST files and/or python contracts, just run:
make html
After installing the necessary packages (see below), start by duplicating temp_locs.py and rename it to locs.py. Change
PARENT_PATH in the hal_py_lib_path variable to the full path to your
copy of the HAL repo (leave the rest of the path unchanged).
Similarly, dulpicate Doxyfile_temp and rename it to Doxyfile. Search
for the variables OUTPUT_DIRECTORY and INPUT, and change PARENT_PATH
to the full path to your copy of the Project-Hybrot.github.io repo and HAL
repo, respectively.
When referencing a HAL class or module, please use the following:
.. include links.rst
|CLASS|_
Where CLASS is the name of the class. This will automatically add the literal format to the name and link to its page. To add this feature for more classes, see
source/links.rst.
- Sphinx
- Read the Docs
- Doxygen, for automatically translating C++ function contracts to XML
- Breathe, which allows sphinx autodoc features to be used on the Doxygen XML output
- MyST, which allows for Sphinx to parse Markdown files