Mercurial > repos > padge > clipkit

diff clipkit_repo/docs/DOCS.md @ 0:49b058e85902 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"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
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/clipkit_repo/docs/DOCS.md	Fri Mar 25 13:04:31 2022 +0000
@@ -0,0 +1,23 @@
+## 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
+```
\ No newline at end of file