Skip to content

vmalloc/devdocs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

43 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Overview

This is a small deployable webapp to index Sphinx-based docs and expose them as Dash docsets.

Install

Deployment requires Ansible to be installed.

To test via vagrant, just run vagrant up. The webserver will be available via http://127.0.0.1:8080. You will need

To install to a server, modify the ansible/inventory file to look like this:

[webservers]
my.deployment.server

And then run

make deploy

Usage

To build a doc from a git repository, post the following:

curl http://my.deployment.server/build -F url=git://your.git.server/repo

Alternatively you can upload a .tgz file containing your already-built HTML directory:

cutl http://my.deployment.server/upload/PROJET_NAME/PROJECT_VERSION -F file=@myfile.tgz

About

Documentation server supporting Dash docsets

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published