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 --work-dir . # 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 domain or IP address> \
> <project name> \
> <documentation root>
$ porfavor publish localhost my_amazing_project docs/_build/html/
Connecting to host on localhost...
Connected successfully!
Publishing content for project 'my_amazing_project'
100%|███████████████████████████████████████████| 108/108 [00:03<00:00, 34.77 files/s]
Finished publishing successfully!
Alternatively, you can write the following script, to make deployment more automatic:
from porfavor import publish
if __name__ == '__main__':
publish(host="localhost",
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.2.0.tar.gz
(3.5 kB
view hashes)