mirror/archivebox
1
0
Fork 0
mirror of https://github.com/pirate/ArchiveBox.git synced 2025-08-30 17:50:04 +02:00
Code Issues Releases Wiki Activity

add instructions for building sphinx docs

Browse Source
This commit is contained in:
Nick Sweeting
2019-04-28 16:46:25 -04:00
parent b86f1c3cbb
commit 4c924ccf7d
13 changed files with 12 additions and 685 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -203,10 +203,20 @@ Whether you want learn which organizations are the big players in the web archiv
<img src="https://read-the-docs-guidelines.readthedocs-hosted.com/_images/logo-dark.png" width="13%" align="right"/>
We use the [Github wiki system](https://github.com/pirate/ArchiveBox/wiki) for documentation.
We use the [Github wiki system](https://github.com/pirate/ArchiveBox/wiki) and [Read the Docs](https://archivebox.readthedocs.io/en/latest/) for documentation.
You can also access the docs locally by looking in the [`ArchiveBox/docs/`](https://github.com/pirate/ArchiveBox/wiki/Home) folder.
You can build the docs by running:
```python
cd ArchiveBox
pipenv install --dev
sphinx-apidoc -o docs archivebox
cd docs/
make html
# then open docs/_build/html/index.html
```
## Getting Started
- [Quickstart](https://github.com/pirate/ArchiveBox/wiki/Quickstart)