Skip to content
This repository was archived by the owner on Jun 9, 2018. It is now read-only.

panviz/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Graphiy KMS Docs

This repo is the source behind http://docs.graphiy.com

Editing

To edit the documentation you need a GitHub account. Once you have created one and logged in, you can edit any page by navigating to the corresponding file and clicking the edit (pen) icon. This will create a so called "fork" and a "pull request", which will be approved by one of the existing documentation team members. Once you have made a contribution or two, you can be added to the documentation team and perform edits without requiring approval.

In the long run, learning to use Git and running Sphinx on your computer is beneficial.

First steps to run it locally:

git clone https://github.com/graphiy/docs.git
pip install sphinx sphinx-autobuild
cd docs
make html
or
make livehtml
# open localhost:8001

The documentation uses the rst format. For a starting point check out the reStructuredText Primer

License

All documentation are licensed under the Creative Commons Attribution 4.0 International License.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published