OpenFisca is a versatile microsimulation free software. This repository contains the source code of its online documentation.
To install dependencies, run:
pip install -r requirements.txt
To build the HTML documentation, run:
make html
The HTML output will be generated in the build/html directory.
To serve the documentation in dev mode, run:
make dev
The documentation will be served on http://127.0.0.1:8000
recommonmark, the library we use to include Markdown-written pages into the Sphinx-generated documentation, seems to have trouble correctly processing links. The current workarounds are:
- Adding an extra
../to links in Markdown-written pages pointing towards the rST-written pages - Dynamically rewriting some links in Javascript