From 6506acd861775726e99dabfc4e3cf7713253330b Mon Sep 17 00:00:00 2001
From: "Elf M. Sternberg"
Date: Thu, 1 Sep 2016 10:55:16 -0700
Subject: [PATCH] Still working out the docs.
---
Makefile | 15 +-
.../index.html} | 46 +++---
docs/_modules/polyloader.html | 106 +++++++++++++
docs/_sources/modules.txt | 7 +
docs/_sources/polyloader.txt | 10 ++
docs/authors.html | 6 +
docs/authors.html.bak | 107 -------------
docs/contributing.html | 6 +
docs/doctrees/authors.doctree | Bin 2776 -> 2778 bytes
docs/doctrees/environment.pickle | Bin 7160 -> 9983 bytes
docs/doctrees/modules.doctree | Bin 0 -> 2844 bytes
docs/doctrees/polyloader.doctree | Bin 0 -> 5281 bytes
docs/doctrees/readme.doctree | Bin 2773 -> 2771 bytes
docs/doctrees/usage.doctree | Bin 2937 -> 2939 bytes
docs/genindex.html | 39 +++++
docs/history.html | 6 +
docs/index.html | 6 +
docs/index.html.bak | 125 ---------------
docs/installation.html | 6 +
docs/installation.html.bak | 144 ------------------
docs/{contributing.html.bak => modules.html} | 51 +++----
docs/objects.inv | Bin 208 -> 264 bytes
docs/{usage.html.bak => polyloader.html} | 65 ++++----
docs/{history.html.bak => py-modindex.html} | 65 ++++----
docs/readme.html | 6 +
docs/readme.html.bak | 107 -------------
docs/search.html | 6 +
docs/search.html.bak | 99 ------------
docs/searchindex.js | 2 +-
docs/src/Makefile | 4 +-
docs/src/modules.rst | 7 +
docs/src/polyloader.rst | 10 ++
docs/todo.html | 6 +
docs/todo.html.bak | 107 -------------
docs/usage.html | 6 +
35 files changed, 360 insertions(+), 810 deletions(-)
rename docs/{genindex.html.bak => _modules/index.html} (61%)
create mode 100644 docs/_modules/polyloader.html
create mode 100644 docs/_sources/modules.txt
create mode 100644 docs/_sources/polyloader.txt
delete mode 100644 docs/authors.html.bak
create mode 100644 docs/doctrees/modules.doctree
create mode 100644 docs/doctrees/polyloader.doctree
delete mode 100644 docs/index.html.bak
delete mode 100644 docs/installation.html.bak
rename docs/{contributing.html.bak => modules.html} (64%)
rename docs/{usage.html.bak => polyloader.html} (57%)
rename docs/{history.html.bak => py-modindex.html} (62%)
delete mode 100644 docs/readme.html.bak
delete mode 100644 docs/search.html.bak
create mode 100644 docs/src/modules.rst
create mode 100644 docs/src/polyloader.rst
delete mode 100644 docs/todo.html.bak
diff --git a/Makefile b/Makefile
index 64e22a0..eaefd51 100644
--- a/Makefile
+++ b/Makefile
@@ -63,12 +63,15 @@ coverage:
$(BROWSER) htmlcov/index.html
docs:
- rm -f docs/polyloader.rst
- rm -f docs/modules.rst
- sphinx-apidoc -o docs/ polyloader
- $(MAKE) -C docs clean
- $(MAKE) -C docs html
- $(BROWSER) docs/_build/html/index.html
+ rm -f docs/src/polyloader.rst
+ rm -f docs/src/modules.rst
+ sphinx-apidoc -o docs/src polyloader
+ $(MAKE) -C docs/src clean
+ $(MAKE) -C docs/src html
+ mv docs/_static/* docs/
+ rm -fr docs/_static
+ perl -pi.bak -e 's/_static\///g' docs/*.html
+ rm docs/*.html.bak
servedocs: docs
watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
diff --git a/docs/genindex.html.bak b/docs/_modules/index.html
similarity index 61%
rename from docs/genindex.html.bak
rename to docs/_modules/index.html
index 3664f5d..38fe9fe 100644
--- a/docs/genindex.html.bak
+++ b/docs/_modules/index.html
@@ -1,4 +1,3 @@
-
@@ -7,33 +6,36 @@
- Index — polyloader 0.1.0 documentation
+ Overview: module code — polyloader 0.1.0 documentation
-
-
+
+
-
-
-
-
+
+
+
+
@@ -42,25 +44,18 @@
-
-
Index
-
-
-
-
-
+
All modules for which code is available
+
diff --git a/docs/history.html b/docs/history.html
index add23e1..d8c6e62 100644
--- a/docs/history.html
+++ b/docs/history.html
@@ -34,6 +34,9 @@
index
+
+ modules |
next |
@@ -90,6 +93,9 @@
index
+
+ modules |
next |
diff --git a/docs/index.html b/docs/index.html
index 29a31a5..65afa4a 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -33,6 +33,9 @@
index
+
+ modules |
next |
@@ -111,6 +114,9 @@
index
+
+ modules |
next |
diff --git a/docs/index.html.bak b/docs/index.html.bak
deleted file mode 100644
index 8f38306..0000000
--- a/docs/index.html.bak
+++ /dev/null
@@ -1,125 +0,0 @@
-
-
-
-
-
-
-
- Welcome to py-polymorphic-loader’s documentation! — polyloader 0.1.0 documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Welcome to py-polymorphic-loader’s documentation!
-
Contents:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/docs/installation.html b/docs/installation.html
index c2f6424..0c1c160 100644
--- a/docs/installation.html
+++ b/docs/installation.html
@@ -34,6 +34,9 @@
index
+
+ modules |
next |
@@ -127,6 +130,9 @@ you through the process.
index
+
+ modules |
next |
diff --git a/docs/installation.html.bak b/docs/installation.html.bak
deleted file mode 100644
index e2a29d3..0000000
--- a/docs/installation.html.bak
+++ /dev/null
@@ -1,144 +0,0 @@
-
-
-
-
-
-
-
- Installation — polyloader 0.1.0 documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Installation
-
-
Stable release
-
To install py-polymorphic-loader, run this command in your terminal:
-
$ pip install py-polymorphic-loader
-
-
-
If you don’t have pip installed, this Python installation guide can guide
-you through the process.
-
-
-
From sources
-
The sources for py-polymorphic-loader can be downloaded from the Github repo .
-
You can either clone the public repository:
-
$ git clone git://github.com/elfsternberg/py-polymorphic-loader
-
-
-
Or download the tarball :
-
$ curl -OL https://github.com/elfsternberg/py-polymorphic-loader/tarball/master
-
-
-
Once you have a copy of the source, you can install it with:
-
$ python setup.py install
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/docs/contributing.html.bak b/docs/modules.html
similarity index 64%
rename from docs/contributing.html.bak
rename to docs/modules.html
index 4c90389..ed60052 100644
--- a/docs/contributing.html.bak
+++ b/docs/modules.html
@@ -6,10 +6,10 @@
- <no title> — polyloader 0.1.0 documentation
+ polyloader — polyloader 0.1.0 documentation
-
-
+
+
-
-
-
-
-
-
+
+
+
+
@@ -49,22 +44,27 @@