Opened 9 years ago

Closed 7 years ago

#4 closed task (fixed)

Migrate the existing documentation to Sphinx

Reported by: cito Owned by: darcy
Priority: minor Milestone: 4.1
Component: Docs Version: 4.0
Keywords: Cc:

Description

We should migrate the existing documentation to Sphinx. See also #3 for creating a HTML theme.

Change History (5)

comment:1 Changed 9 years ago by cito

Also add more and better documented example code snippets that can be easily copied and pasted.

comment:2 Changed 9 years ago by cito

The mkdocs script should be modified to use Sphinx, and docs should be installable with python setup.py install-docs.

Last edited 9 years ago by cito (previous) (diff)

comment:3 Changed 7 years ago by cito

The docs could then also be published at https://readthedocs.org/.

comment:4 Changed 7 years ago by darcy

I have created Sphinx documents. They probably need some work still but I think we can get started with it. Should I commit now or wait until after 4.1 is released?

comment:5 Changed 7 years ago by darcy

  • Resolution set to fixed
  • Status changed from new to closed

Basic conversion is completed and committed.

Note: See TracTickets for help on using tickets.