The source for ODK documentation published at https://docs.getodk.org.
Please file an issue if you can't find what you are looking for.
[!NOTE] The source for the Central API documentation is managed in the Central code repository and copied here as part of the Central release process.
We highly recommend you use a virtual environment like virtualenv
. If you need to use different versions of Python, we recommend pyenv
.
Clone the docs repo and make sure all the requirements are installed:
$ git clone https://github.com/getodk/docs.git
$ cd docs/
If you wish to use virtualenv, now is a good time to set it up:
$ python -m venv venv
$ source venv/bin/activate
You will see (venv)
next to your prompt to indicate you are working within the docs project. To exit this mode, use the command deactivate
.
Whether you are using virtualenv or not, you next need to install the dependencies:
$ pip install -r requirements.txt
It can take a long time (>10 minutes) to clone the repo due to the large number of images in the docs. If you get an error such as Smudge error
or GitHub's rate limit reached
, run git checkout -f HEAD
until you get the message Checking out files: 100% done
.
Once your environment is set up, build and serve the docs locally with:
$ make autobuild
You can then view the docs in your browser at http://localhost:8000. The docs will auto-build and refresh as you make changes to the source files.
You can use make dirhtml
to for a one-time build of the HTML files and make clean
to clean the build.
We are open for new issues and pull requests.
You can also...
extension error
or a configuration error
:
python --version
to check your current python version (it should be 3.10+).pip install -r requirements.txt
.