https://github.com/divio/user-support-guides
https://github.com/divio/user-support-guides
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/divio/user-support-guides
- Owner: divio
- License: mit
- Created: 2021-01-20T09:41:57.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-08-06T08:38:54.000Z (almost 5 years ago)
- Last Synced: 2025-01-20T09:46:41.763Z (over 1 year ago)
- Language: Python
- Size: 1.06 MB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# divio-docs
Divio User handbook
Published version: Divio user handbook.
This documentation is intended for Divio customers.
Build the documentation locally
You'll need the enchant library, used by pyenchant for spelling.
Install with brew install enchant (macOS) or the appropriate command for your system.
Then:
git clone git@github.com:divio/divio-docs.git # clone
cd divio-docs
make install # create a virtualenv and install required components
make run # build and serve the documentation
open http://localhost:8001 # open it in a browser
Notable techniques used in this documentation
Read the Docs
We serve our documentation via Read the Docs, a superb free service that's especially well-known in the Python world, and is ideal for open-source projects.
The documentation is written in ReStructed Text (RST) and built using Sphinx.