Mercurial > repos > padge > clipkit
comparison clipkit_repo/docs/DOCS.md @ 0:49b058e85902 draft
"planemo upload for repository https://github.com/jlsteenwyk/clipkit commit cbe1e8577ecb1a46709034a40dff36052e876e7a-dirty"
| author | padge |
|---|---|
| date | Fri, 25 Mar 2022 13:04:31 +0000 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| -1:000000000000 | 0:49b058e85902 |
|---|---|
| 1 ## Documentation | |
| 2 The documentation is built using Sphinx. Assuming you have Python 3 and [pipenv](https://pipenv.readthedocs.io/en/latest/install/#installing-pipenv) | |
| 3 installed, run the following: | |
| 4 | |
| 5 ```shell | |
| 6 cd docs | |
| 7 pipenv install --dev | |
| 8 ``` | |
| 9 | |
| 10 #### Running the Development Server | |
| 11 You can run a local development server to preview changes using the following: | |
| 12 | |
| 13 ```shell | |
| 14 cd docs | |
| 15 pipenv run serve | |
| 16 ``` | |
| 17 | |
| 18 #### Running Manually | |
| 19 You can build the docs manually by running: | |
| 20 ```shell | |
| 21 cd docs | |
| 22 pipenv run make html | |
| 23 ``` |