Skip to content

Commit

Permalink
Add API docs
Browse files Browse the repository at this point in the history
API doc sources are generated by "make apidocs". The modules.rst
file is then pulled into index.rst.
  • Loading branch information
sgillies committed Jun 30, 2013
1 parent e81631f commit 89f0b42
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 13 deletions.
5 changes: 5 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -151,3 +151,8 @@ doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."

apidocs:
sphinx-apidoc -f -o . ../src/fiona
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
5 changes: 3 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
# All configuration values have a default; values that are commented out
# serve to show the default.

import fiona
import sys, os

# If extensions (or modules to document with autodoc) are in another directory,
Expand Down Expand Up @@ -48,9 +49,9 @@
# built documents.
#
# The short X.Y version.
version = '0.10'
version = fiona.__version__
# The full version, including alpha/beta/rc tags.
release = '0.10'
release = fiona.__version__

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
14 changes: 4 additions & 10 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,12 @@
.. Fiona documentation master file, created by
sphinx-quickstart on Mon Dec 26 12:16:26 2011.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Fiona's documentation!
=================================

Contents:
Fiona Documentation Contents
============================

.. toctree::
:maxdepth: 2

README
manual
User Manual <manual>
API Documentation <modules>


Indices and tables
Expand Down
3 changes: 2 additions & 1 deletion docs/manual.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ The Fiona User Manual
=====================

:Author: Sean Gillies, <sean.gillies@gmail.com>
:Date: 23 March 2013
:Version: |release|
:Date: |today|
:Copyright:
This work is licensed under a `Creative Commons Attribution 3.0
United States License`__.
Expand Down

0 comments on commit 89f0b42

Please sign in to comment.