This project contains the source of Centra's public API documentation. The documentation is located at https://docs.centra.com.
Thanks to Mollie for licensing their API Documentation under CC BY-SA 4.0. We've adapted their theme and made some changes that worked for us. Thank you very much!
We take pull requests on our documentation as well, if you think that something can be improved please open a PR.
The documentation is formatted using markdown. All documentation should be written in US English.
- Python > 2.7.9
- pip, Python's package manager. Installation instructions.
- Node > 9.x
Create a fork, or clone this repository if you have write access:
git clone [email protected]:centrahq/api-documentation.git
Then visit the downloaded repository and install dependencies:
cd api-documentation
make install
Finally, build the documentation, its CSS and JS files by running:
make html
You can now preview the generated documentation by opening build/html/index.html
:
open build/html/index.html
After running make html
at least once, you can use make html-only
to quickly update the HTML files if you changed
some copy. This way, you can have a quick REPL.
$ make html-only
Running Sphinx v1.8.3
...
updating environment: 0 added, 2 changed, 0 removed
...
build succeeded.
The HTML pages are in build/html.
$ open build/html/index.html
Sphinx will only update files for which the source files have changed.
You can make changes to the styling by starting a web server locally:
make start
Visit http://localhost:8000
to preview your changes. CSS & JS changes will appear without the need to refresh your
browser.
Deployment is handled using continuous deployment.
Successful builds on the master
branch will be automatically deployed.
Redirects are handled using a Lambda@Edge function installed on the North Carolina AWS region. This Lambda@Edge contains the code from: origin-response.js.
Update the function and deploy it again at Lambda@Edge to add more redirects.
If you are having issues, please let us know. We accept pull requests on our public documentation.
You can get support via [email protected].
We have a career page listing our current positions: Centra Careers.
The documentation is licensed under the CC BY-SA 4.0 license.