-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 841af8a
Showing
25 changed files
with
3,730 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Sphinx build info version 1 | ||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. | ||
config: c6b24c6e3183e93975b2525569bad4fc | ||
tags: 645f666f9bcd5a90fca523b33c5a78b7 |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
pytemplate | ||
========== | ||
|
||
Demo Sphinx site for the `CQCL pytemplate <https://github.com/CQCL/pytemplate>`_ project. | ||
|
||
---- | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
:caption: Contents: | ||
|
||
modules | ||
|
||
Installation | ||
------------ | ||
|
||
To install pytemplate, simply run: | ||
|
||
.. code-block:: bash | ||
pip install pytemplate | ||
Usage | ||
----- | ||
|
||
To use pytemplate, import the main module: | ||
|
||
.. code-block:: python | ||
from pytemplate import main | ||
main.run() | ||
Utils | ||
----- | ||
|
||
The utils module contains various utility functions that can be used in conjunction with pytemplate. To use the utils module, import it like so: | ||
|
||
.. code-block:: python | ||
from pytemplate import utils | ||
utils.do_something() | ||
Indices and tables | ||
================== | ||
|
||
* :ref:`genindex` | ||
* :ref:`modindex` | ||
* :ref:`search` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
pytemplate | ||
========== | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
pytemplate |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
pytemplate package | ||
================== | ||
|
||
Submodules | ||
---------- | ||
|
||
pytemplate.main module | ||
---------------------- | ||
|
||
.. automodule:: pytemplate.main | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
pytemplate.utils module | ||
----------------------- | ||
|
||
.. automodule:: pytemplate.utils | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: pytemplate | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Oops, something went wrong.