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",
root_dir="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.5.1.tar.gz
(432.4 kB
view hashes)
Built Distribution
porfavor-0.5.1-py2.py3-none-any.whl
(434.5 kB
view hashes)
Close
Hashes for porfavor-0.5.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0bd4f27bc40fd8c4cbfe88eaa4b71fa1198f9e96e8f16e3df2eb08434afbf725 |
|
MD5 | a0f99763534693da2e5d65dfab09354e |
|
BLAKE2b-256 | 90b7bcb3840900be5211f7ac12522f21d97982703cb6cfec62b43473ba46fd51 |