view clipkit_repo/docs/DOCS.md @ 2:e9cf321ee7be draft

"planemo upload for repository https://github.com/jlsteenwyk/clipkit commit cbe1e8577ecb1a46709034a40dff36052e876e7a-dirty"
author padge
date Fri, 25 Mar 2022 17:33:41 +0000
parents 49b058e85902
children
line wrap: on
line source

## Documentation
The documentation is built using Sphinx. Assuming you have Python 3 and [pipenv](https://pipenv.readthedocs.io/en/latest/install/#installing-pipenv)
installed, run the following:

```shell
cd docs
pipenv install --dev
```

#### Running the Development Server
You can run a local development server to preview changes using the following:

```shell
cd docs
pipenv run serve
```

#### Running Manually
You can build the docs manually by running:
```shell
cd docs
pipenv run make html
```