Skip to content

Documentation based on sphinx/rst for the Agave project.

Notifications You must be signed in to change notification settings

maytaldahan/agave-docs

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Agave Documentation

Quickstart

  1. Create a Python 3 environment
  2. Install dependencies pip install -r requirements.txt
  3. Build using make html (Mac/Linux) or make.bat html (Windows)

If you pip install sphinx-autobuild, you can use make livehtml which will start a server that watches for source changes and will rebuild/refresh automatically. Go to http://localhost:8000/ to see its output.

reStructuredText help

rST is a bit more onerous than Markdown, but it includes more advanced features like inter-page references/links and a suite of directives.

About

Documentation based on sphinx/rst for the Agave project.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published