ocl-docs

Consolidated documentation for OCL. This documentation supports both Markdown (.md) and Restructured Text (.rst) files. This repository is directly linked to the content in https://docs.openconceptlab.org (or https://ocl-docs.readthedocs.io/). Commits are automatically built and deployed to that website.

How to contribute -

To add/edit content in an existing page

Add or Edit content in any page under https://github.com/OpenConceptLab/ocl-docs/tree/main/docs/source and commit the changes.

To add a new page

Add a page under - https://github.com/OpenConceptLab/ocl-docs/tree/main/docs/source or any folder under this page

To build and verify changes locally

Note: If you want to edit files locally and/or are planning to make multiple edits and want to avoid multiple commits. Follow the following steps

1. Clone the repo
2. install requirements using pip install -r requirements.txt
3. Go to docs folder
4. Execute make clean to clean earlier changes
5. execute make html and if the build is successful it should return with -

build succeeded.
The HTML pages are in build/html.

5. You should be able to open the index.html file under docs/build/html and view the final result of your changes
6. You can commit and push your changes once you are happy with the end result

License

This repository is part of the OCL Digital Public Good. Its documentation is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).