-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
0b02df2
commit 78fc178
Showing
3 changed files
with
2 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,29 +1,3 @@ | ||
# OCP Software Development Handbook | ||
|
||
A guide for developers of OCP's tools. | ||
|
||
This repository was originally based on OpenDataServices' [sphinx-base](https://github.com/OpenDataServices/sphinx-base). See its [instructions for ReadTheDocs setup](https://github.com/OpenDataServices/sphinx-base#building-on-readthedocs). | ||
|
||
## Build and view the documentation | ||
|
||
Create and activate a virtual environment, then install requirements: | ||
|
||
```shell | ||
pip install -r requirements.txt | ||
``` | ||
|
||
And build the documentation: | ||
|
||
``` | ||
cd docs | ||
make html | ||
``` | ||
|
||
The built documentation is in `_build/html` under `docs`. To view the documentation: | ||
|
||
```shell | ||
cd _build/html | ||
python -m http.server | ||
``` | ||
|
||
And open <http://localhost:8000/> in a browser. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.