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 - - + + - - - - + + + +

Navigation

@@ -42,25 +44,18 @@
- -

Index

- -
- -
- +

All modules for which code is available

+
- - -
diff --git a/docs/_modules/polyloader.html b/docs/_modules/polyloader.html new file mode 100644 index 0000000..c5656c4 --- /dev/null +++ b/docs/_modules/polyloader.html @@ -0,0 +1,106 @@ + + + + + + + + polyloader — polyloader 0.1.0 documentation + + + + + + + + + + + + +
+

Navigation

+ +
+ +
+
+
+
+ +

Source code for polyloader

+# -*- coding: utf-8 -*-
+import sys
+
+__author__ = 'Kenneth M. "Elf" Sternberg'
+__email__ = 'elf.sternberg@gmail.com'
+__version__ = '0.1.0'
+
+if sys.version_info[0:2] >= (2, 6):
+    from ._python2 import install, reset
+
+if sys.version_info[0] >= 3:
+    from ._python3 import install, reset
+
+__all__ = ['install', 'reset']
+
+ +
+
+
+
+
+ + +
+
+
+
+
+

Navigation

+ +
+
+ © Copyright 2016, Kenneth M. "Elf" Sternberg. + Created using Sphinx 1.2.2. +
+ + \ No newline at end of file diff --git a/docs/_sources/modules.txt b/docs/_sources/modules.txt new file mode 100644 index 0000000..a2f24a7 --- /dev/null +++ b/docs/_sources/modules.txt @@ -0,0 +1,7 @@ +polyloader +========== + +.. toctree:: + :maxdepth: 4 + + polyloader diff --git a/docs/_sources/polyloader.txt b/docs/_sources/polyloader.txt new file mode 100644 index 0000000..ed35365 --- /dev/null +++ b/docs/_sources/polyloader.txt @@ -0,0 +1,10 @@ +polyloader package +================== + +Module contents +--------------- + +.. automodule:: polyloader + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/authors.html b/docs/authors.html index 829a9e1..73cade4 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -34,6 +34,9 @@
  • index
    • +
  • + modules |
  • next |
    • @@ -90,6 +93,9 @@
  • index
    • +
  • + modules |
  • next |
    • diff --git a/docs/authors.html.bak b/docs/authors.html.bak deleted file mode 100644 index 17aed54..0000000 --- a/docs/authors.html.bak +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - - <no title> — polyloader 0.1.0 documentation - - - - - - - - - - - - - -
    -

    Navigation

    - -
    - -
    -
    -
    -
    - - - -
    -
    -
    -
    -
    -

    Previous topic

    -

    <no title>

    -

    Next topic

    -

    <no title>

    -

    This Page

    - - - -
    -
    -
    -
    -
    -

    Navigation

    - -
    -
    - © Copyright 2016, Kenneth M. "Elf" Sternberg. - Created using Sphinx 1.2.2. -
    - - \ No newline at end of file diff --git a/docs/contributing.html b/docs/contributing.html index ab3c34e..7565fbc 100644 --- a/docs/contributing.html +++ b/docs/contributing.html @@ -34,6 +34,9 @@
  • index
    • +
  • + modules |
  • next |
    • @@ -90,6 +93,9 @@
  • index
    • +
  • + modules |
  • next |
    • diff --git a/docs/doctrees/authors.doctree b/docs/doctrees/authors.doctree index 809b578..8b2e811 100644 Binary files a/docs/doctrees/authors.doctree and b/docs/doctrees/authors.doctree differ diff --git a/docs/doctrees/environment.pickle b/docs/doctrees/environment.pickle index 37a924b..441de3d 100644 Binary files a/docs/doctrees/environment.pickle and b/docs/doctrees/environment.pickle differ diff --git a/docs/doctrees/modules.doctree b/docs/doctrees/modules.doctree new file mode 100644 index 0000000..ab3029e Binary files /dev/null and b/docs/doctrees/modules.doctree differ diff --git a/docs/doctrees/polyloader.doctree b/docs/doctrees/polyloader.doctree new file mode 100644 index 0000000..c93a229 Binary files /dev/null and b/docs/doctrees/polyloader.doctree differ diff --git a/docs/doctrees/readme.doctree b/docs/doctrees/readme.doctree index 9dd1ca0..5a9cbac 100644 Binary files a/docs/doctrees/readme.doctree and b/docs/doctrees/readme.doctree differ diff --git a/docs/doctrees/usage.doctree b/docs/doctrees/usage.doctree index ed2fdbe..df6f7a7 100644 Binary files a/docs/doctrees/usage.doctree and b/docs/doctrees/usage.doctree differ diff --git a/docs/genindex.html b/docs/genindex.html index 2930807..4006062 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -33,6 +33,9 @@
  • index
    • +
  • + modules |
  • polyloader 0.1.0 documentation »
    • @@ -46,8 +49,41 @@

    Index

    + I + | P + | R
    +

    I

    + + +
    + +
    install() (in module polyloader) +
    + +
    + +

    P

    + + +
    + +
    polyloader (module) +
    + +
    + +

    R

    + + +
    + +
    reset() (in module polyloader) +
    + +
    +
    @@ -81,6 +117,9 @@
  • index
    • +
  • + modules |
  • polyloader 0.1.0 documentation »
    • 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 - - - - - - - - - - - - -
    -

    Navigation

    - -
    - -
    -
    -
    -
    - -
    -

    Welcome to py-polymorphic-loader’s documentation!

    -

    Contents:

    -
    - -
    -
    -
    -

    Indices and tables

    - -
    - - -
    -
    -
    -
    -
    -

    Table Of Contents

    - - -

    Next topic

    -

    <no title>

    -

    This Page

    - - - -
    -
    -
    -
    -
    -

    Navigation

    - -
    -
    - © Copyright 2016, Kenneth M. "Elf" Sternberg. - Created using Sphinx 1.2.2. -
    - - \ 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 - - - - - - - - - - - - - -
    -

    Navigation

    - -
    - -
    -
    -
    -
    - -
    -

    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
-
    -
    -
    -
    - - -
    -
    -
    -
    -
    -

    Table Of Contents

    - - -

    Previous topic

    -

    <no title>

    -

    Next topic

    -

    Usage

    -

    This Page

    - - - -
    -
    -
    -
    -
    -

    Navigation

    - -
    -
    - © Copyright 2016, Kenneth M. "Elf" Sternberg. - Created using Sphinx 1.2.2. -
    - - \ 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 - - + + - - - - - - + + + +
    @@ -35,11 +33,8 @@ index
  • - next |
    • -
  • - previous |
    • + modules |
  • polyloader 0.1.0 documentation »
    • @@ -49,22 +44,27 @@
    - +
    +

    polyloader

    +
    + +
    +
    +
    -

    Previous topic

    -

    Usage

    -

    Next topic

    -

    <no title>

    This Page

    diff --git a/docs/objects.inv b/docs/objects.inv index 5c9a61a..3d52b9e 100644 Binary files a/docs/objects.inv and b/docs/objects.inv differ diff --git a/docs/usage.html.bak b/docs/polyloader.html similarity index 57% rename from docs/usage.html.bak rename to docs/polyloader.html index 2db2344..af9d2ab 100644 --- a/docs/usage.html.bak +++ b/docs/polyloader.html @@ -6,10 +6,10 @@ - Usage — polyloader 0.1.0 documentation + polyloader package — polyloader 0.1.0 documentation - - + + - - - - - - + + + +
    @@ -35,11 +33,8 @@ index
  • - next |
    • -
  • - previous |
    • + modules |
  • polyloader 0.1.0 documentation »
    • @@ -49,11 +44,20 @@
    -
    -

    Usage

    -

    To use py-polymorphic-loader in a project:

    -
    import py-polymorphic-loader
-
    +
    +

    polyloader package

    +
    +

    Module contents

    +
    +
    +polyloader.install(compiler, suffixes)
    +
    + +
    +
    +polyloader.reset()
    +
    +
    @@ -63,15 +67,17 @@
    -

    Previous topic

    -

    Installation

    -

    Next topic

    -

    <no title>

    +

    Table Of Contents

    + +

    This Page

    diff --git a/docs/history.html.bak b/docs/py-modindex.html similarity index 62% rename from docs/history.html.bak rename to docs/py-modindex.html index 1d6a73d..82c3895 100644 --- a/docs/history.html.bak +++ b/docs/py-modindex.html @@ -6,10 +6,10 @@ - <no title> — polyloader 0.1.0 documentation + Python Module Index — polyloader 0.1.0 documentation - - + + - - - + + + - - + + + + +
    @@ -35,11 +40,8 @@ index
  • - next |
    • -
  • - previous |
    • + modules |
  • polyloader 0.1.0 documentation »
    • @@ -49,24 +51,30 @@
    - + +

    Python Module Index

    + +
    + p +
    + + + + + + + +
     
    + p
    + polyloader +
    +
    -

    Previous topic

    -

    <no title>

    -

    Next topic

    -

    <no title>

    -

    This Page

    - diff --git a/docs/readme.html b/docs/readme.html index a1eccc2..9e07216 100644 --- a/docs/readme.html +++ b/docs/readme.html @@ -34,6 +34,9 @@
  • index
    • +
  • + modules |
  • next |
    • @@ -90,6 +93,9 @@
  • index
    • +
  • + modules |
  • next |
    • diff --git a/docs/readme.html.bak b/docs/readme.html.bak deleted file mode 100644 index 3766248..0000000 --- a/docs/readme.html.bak +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - - <no title> — polyloader 0.1.0 documentation - - - - - - - - - - - - - -
    -

    Navigation

    - -
    - -
    -
    -
    -
    - - - -
    -
    -
    -
    -
    -

    Previous topic

    -

    Welcome to py-polymorphic-loader’s documentation!

    -

    Next topic

    -

    Installation

    -

    This Page

    - - - -
    -
    -
    -
    -
    -

    Navigation

    - -
    -
    - © Copyright 2016, Kenneth M. "Elf" Sternberg. - Created using Sphinx 1.2.2. -
    - - \ No newline at end of file diff --git a/docs/search.html b/docs/search.html index 52af06a..84fecd6 100644 --- a/docs/search.html +++ b/docs/search.html @@ -40,6 +40,9 @@
  • index
    • +
  • + modules |
  • polyloader 0.1.0 documentation »
    • @@ -88,6 +91,9 @@
  • index
    • +
  • + modules |
  • polyloader 0.1.0 documentation »
    • diff --git a/docs/search.html.bak b/docs/search.html.bak deleted file mode 100644 index f376ac9..0000000 --- a/docs/search.html.bak +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - - Search — polyloader 0.1.0 documentation - - - - - - - - - - - - - - - - - -
    -

    Navigation

    - -
    - -
    -
    -
    -
    - -

    Search

    -
    - -

    - Please activate JavaScript to enable the search - functionality. -

    -
    -

    - From here you can search these documents. Enter your search - words into the box below and click "search". Note that the search - function will automatically search for all of the words. Pages - containing fewer words won't appear in the result list. -

    -
    - - - -
    - -
    - -
    - -
    -
    -
    -
    -
    -
    -
    -
    -
    -
    -

    Navigation

    - -
    -
    - © Copyright 2016, Kenneth M. "Elf" Sternberg. - Created using Sphinx 1.2.2. -
    - - \ No newline at end of file diff --git a/docs/searchindex.js b/docs/searchindex.js index 7ccb6d2..1239563 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({envversion:42,terms:{compil:6,set:6,suffix:6,creat:6,process:1,onc:1,modul:0,remov:6,automat:6,pip:1,through:1,have:1,instal:[],tarbal:1,stabl:[],download:1,guid:1,assum:6,your:1,index:0,git:1,from:[],activ:6,content:0,leav:6,which:6,pair:6,master:1,you:1,"public":1,either:1,elfsternberg:1,sourc:[],run:[6,1],context:6,python:[6,1],upon:6,clone:1,copi:1,usag:[],curl:1,standard:6,repo:1,scope:6,mechan:6,repositori:1,termin:1,releas:[],last:6,search:0,github:1,don:1,setup:1,current:6,http:1,manag:6,project:3,polyload:6,instanc:6,command:1,can:1,thi:1,lifetim:6,com:1,page:0,"import":3},objtypes:{},objnames:{},filenames:["index","installation","contributing","usage","authors","readme","todo","history"],titles:["Welcome to py-polymorphic-loader’s documentation!","Installation","<no title>","Usage","<no title>","<no title>","<no title>","<no title>"],objects:{},titleterms:{polymorph:0,sourc:1,from:1,welcom:0,usag:3,indic:0,loader:0,tabl:0,releas:1,stabl:1,document:0,instal:1}}) \ No newline at end of file +Search.setIndex({envversion:42,terms:{compil:[7,8],set:8,suffix:[7,8],creat:8,process:1,onc:1,modul:[0,2],automat:8,pip:1,through:1,have:1,instal:0,tarbal:1,stabl:0,download:1,guid:1,assum:8,your:1,page:0,index:0,git:1,from:0,activ:8,content:[0,2],leav:8,which:8,master:1,you:1,"public":1,can:1,elfsternberg:1,setup:1,sourc:0,run:[8,1],thi:1,python:[8,1],usag:0,clone:1,copi:1,upon:8,curl:1,standard:8,repo:1,releas:0,mechan:8,repositori:1,termin:1,pair:8,don:1,reset:7,search:0,github:1,last:8,packag:2,remov:8,current:8,http:1,manag:8,project:6,instanc:8,command:1,either:1,context:8,lifetim:8,com:1,scope:8,"import":6},objtypes:{"0":"py:module","1":"py:function"},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"]},filenames:["index","installation","modules","contributing","readme","authors","usage","polyloader","todo","history"],titles:["Welcome to py-polymorphic-loader’s documentation!","Installation","polyloader","<no title>","<no title>","<no title>","Usage","polyloader package","<no title>","<no title>"],objects:{"":{polyloader:[7,0,0,"-"]},polyloader:{reset:[7,1,1,""],install:[7,1,1,""]}},titleterms:{polymorph:0,sourc:1,from:1,welcom:0,modul:7,usag:6,indic:0,loader:0,content:7,packag:7,polyload:[7,2],tabl:0,releas:1,stabl:1,document:0,instal:1}}) \ No newline at end of file diff --git a/docs/src/Makefile b/docs/src/Makefile index 697d546..5ef8bdf 100644 --- a/docs/src/Makefile +++ b/docs/src/Makefile @@ -38,12 +38,12 @@ help: @echo " linkcheck to check all external links for integrity" clean: - rm -rf $(BUILDDIR)/* + rm -rf $(BUILDDIR)/doctrees $(BUILDDIR)/_* $(BUILDDIR)/*.* html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR) @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + @echo "Build finished. The HTML pages are in $(BUILDDIR)." dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml diff --git a/docs/src/modules.rst b/docs/src/modules.rst new file mode 100644 index 0000000..a2f24a7 --- /dev/null +++ b/docs/src/modules.rst @@ -0,0 +1,7 @@ +polyloader +========== + +.. toctree:: + :maxdepth: 4 + + polyloader diff --git a/docs/src/polyloader.rst b/docs/src/polyloader.rst new file mode 100644 index 0000000..ed35365 --- /dev/null +++ b/docs/src/polyloader.rst @@ -0,0 +1,10 @@ +polyloader package +================== + +Module contents +--------------- + +.. automodule:: polyloader + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/todo.html b/docs/todo.html index cb020d9..8840ec0 100644 --- a/docs/todo.html +++ b/docs/todo.html @@ -33,6 +33,9 @@
  • index
    • +
  • + modules |
  • previous |
    • @@ -93,6 +96,9 @@ that pair upon leaving the scope.
  • index
    • +
  • + modules |
  • previous |
    • diff --git a/docs/todo.html.bak b/docs/todo.html.bak deleted file mode 100644 index e2ee18e..0000000 --- a/docs/todo.html.bak +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - - <no title> — polyloader 0.1.0 documentation - - - - - - - - - - - - -
    -

    Navigation

    - -
    - -
    -
    -
    -
    - -

    Currently assumes that Polyloaders last for the lifetime of the Python -instance. There is no standardized mechanism for removing a -compiler/suffix set from a running instance.

    -
      -
    1. Create a standardized mechanism for removing a compiler/suffix from -the running instance.
      2. -
    2. Create a ‘with’ context manager that creates a scope in which a -Polyloader compiler/suffix pair is active, and automatically removes -that pair upon leaving the scope.
      3. -
    - - -
    -
    -
    -
    -
    -

    Previous topic

    -

    <no title>

    -

    This Page

    - - - -
    -
    -
    -
    -
    -

    Navigation

    - -
    -
    - © Copyright 2016, Kenneth M. "Elf" Sternberg. - Created using Sphinx 1.2.2. -
    - - \ No newline at end of file diff --git a/docs/usage.html b/docs/usage.html index ffc2f94..f046638 100644 --- a/docs/usage.html +++ b/docs/usage.html @@ -34,6 +34,9 @@
  • index
    • +
  • + modules |
  • next |
    • @@ -97,6 +100,9 @@
  • index
    • +
  • + modules |
  • next |