Publishing static documentation the easy way
Project description
Por favor
Publishing static documentation the easiest way possible!
Install
$ pip install porfavor
Use
On the server side, you should run the matching server-side implementation. It listens to any client and puts the given documentation in its right place.
On the server, run:
$ pip install porfavor
...
$ porfavor serve . # replace '.' with the desired working directory
...
Now, to deploy documentation on the server, all you have to do is running
porfavor publish
with the right arguments:
$ # porfavor publish <server's URL> \
> <project name> \
> <documentation root>
$ porfavor publish localhost:5000 my_amazing_project docs/_build/html/
Zipping content of folder 'docs/_build/html'... DONE!
Publishing content for project 'my_amazing_project'... DONE!
Alternatively, you can write the following script, to make deployment more automatic:
from porfavor import publish
if __name__ == '__main__':
publish(host="localhost:5000",
project="project_name",
file_or_directory="root_dir")
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
porfavor-0.6.0.tar.gz
(433.5 kB
view hashes)
Built Distribution
porfavor-0.6.0-py2.py3-none-any.whl
(437.0 kB
view hashes)
Close
Hashes for porfavor-0.6.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2400c81cb1b1de56deb6d79bd1ef13947851e6845fcf39b1df5f85cf82854355 |
|
MD5 | b62bde072c38a5ea8de2ae9f5d9ecb4d |
|
BLAKE2b-256 | 3494c159a112993f5c280f769ad944f9727657f6e81851c4952d2f58b9cc9032 |