Skip to content
JamDocs is a web interface for Sphinx documentation generator powered by Jam.py
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
css
jam
js
locks
static
.gitignore
LICENSE
README.rst
admin.sqlite
index.html
jamdoc.sqlite
langs.sqlite
server.py
wsgi.py

README.rst

JamDocs

JamDocs is a web interface for Sphinx documentation generator. It makes it very easy to create intelligent and beautiful documentation.

Requirements

  • One of the following Python version must be installed: 3.5, 3.6, 3.7.
  • Sphinx python library must be installed.

Main features

  • Very simple, in a couple of clicks, adding internal links to other documentation files, inserting images and figures
  • Easy creation of external links
  • Ability to work with multiple files in adjacent tabs
  • Preview changes on the page of the browser with one click.
  • Simple addition and removal of files and folders of documentation.
  • Automatic synchronization of the application with changes to the files in the documentation directory.

Getting started

  1. Download the archive
  2. Create a new directory and unpack the archive there
  3. Go into the directory and run the server.py script. You can specify a port as parameter
  4. In the browser, type 127.0.0.1:8080 in the address bar. If you specified another port, replace 8080 with the port.
  5. In the dialog that will appear input name of the Sphinx project and a path to conf.py of the project. Click OK button to save data and double-click the project to select it.

Video tutorial

This video demonstrates how to set up and use JamDocs

Author

Andrew Yushev

JamDocs is an application written in Jam.py.

It was used to create Jam.py framework documentation.

You can’t perform that action at this time.