OpenFisca is a versatile microsimulation free software. This repository contains the source code of its online documentation.
To install dependencies, run:
make install
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
To test the documentation, run:
make test
If the tests fail, here's what you can do:
-
If the errors also concern OpenFisca-Core, please take a look at the README.
-
If not, clone & install the documentation:
git clone https://github.com/openfisca/openfisca-doc
make install
- create a branch to correct the problems:
git checkout -b fix-doc
- Fix the offending problems.
You can test-drive your fixes by checking that each change works as expected:
make test
- Commit at each step, so you don't accidentally lose your progress:
git add -A && git commit -m "Fixed missing doctree"
- Once you're done, push your changes:
git push origin `git branch --show-current`
- Finally, open a pull request.
That's it! 🙌
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