xnn-step 2026.9.18__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. xnn_step-2026.9.18/AUTHORS.rst +5 -0
  2. xnn_step-2026.9.18/CONTRIBUTING.rst +113 -0
  3. xnn_step-2026.9.18/HISTORY.rst +12 -0
  4. xnn_step-2026.9.18/LICENSE +31 -0
  5. xnn_step-2026.9.18/MANIFEST.in +14 -0
  6. xnn_step-2026.9.18/PKG-INFO +125 -0
  7. xnn_step-2026.9.18/README.rst +68 -0
  8. xnn_step-2026.9.18/docs/Makefile +177 -0
  9. xnn_step-2026.9.18/docs/_static/SEAMM Inverted 288x181.png +0 -0
  10. xnn_step-2026.9.18/docs/_static/SEAMM logo.png +0 -0
  11. xnn_step-2026.9.18/docs/_static/molssi_main_logo.png +0 -0
  12. xnn_step-2026.9.18/docs/_static/molssi_main_logo_inverted_white.png +0 -0
  13. xnn_step-2026.9.18/docs/_static/molssi_square.png +0 -0
  14. xnn_step-2026.9.18/docs/_static/nsf.png +0 -0
  15. xnn_step-2026.9.18/docs/api/index.rst +17 -0
  16. xnn_step-2026.9.18/docs/authors.rst +1 -0
  17. xnn_step-2026.9.18/docs/conf.py +306 -0
  18. xnn_step-2026.9.18/docs/developer_guide/campaigns/YYYY-MM-DD/index.rst +16 -0
  19. xnn_step-2026.9.18/docs/developer_guide/campaigns/index.rst +17 -0
  20. xnn_step-2026.9.18/docs/developer_guide/contributing.rst +1 -0
  21. xnn_step-2026.9.18/docs/developer_guide/index.rst +28 -0
  22. xnn_step-2026.9.18/docs/developer_guide/installation.rst +54 -0
  23. xnn_step-2026.9.18/docs/developer_guide/usage.rst +7 -0
  24. xnn_step-2026.9.18/docs/getting_started/index.rst +45 -0
  25. xnn_step-2026.9.18/docs/history.rst +1 -0
  26. xnn_step-2026.9.18/docs/index.rst +72 -0
  27. xnn_step-2026.9.18/docs/make.bat +242 -0
  28. xnn_step-2026.9.18/docs/user_guide/index.rst +66 -0
  29. xnn_step-2026.9.18/requirements.txt +4 -0
  30. xnn_step-2026.9.18/requirements_dev.txt +10 -0
  31. xnn_step-2026.9.18/requirements_install.txt +4 -0
  32. xnn_step-2026.9.18/setup.cfg +27 -0
  33. xnn_step-2026.9.18/setup.py +91 -0
  34. xnn_step-2026.9.18/tests/__init__.py +3 -0
  35. xnn_step-2026.9.18/tests/test_xnn_step.py +174 -0
  36. xnn_step-2026.9.18/versioneer.py +1883 -0
  37. xnn_step-2026.9.18/xnn_step/__init__.py +26 -0
  38. xnn_step-2026.9.18/xnn_step/__main__.py +22 -0
  39. xnn_step-2026.9.18/xnn_step/_version.py +21 -0
  40. xnn_step-2026.9.18/xnn_step/data/configuration.txt +7 -0
  41. xnn_step-2026.9.18/xnn_step/data/properties.csv +1 -0
  42. xnn_step-2026.9.18/xnn_step/data/references.bib +40 -0
  43. xnn_step-2026.9.18/xnn_step/data/seamm-xnn.yml +20 -0
  44. xnn_step-2026.9.18/xnn_step/data/xnn.ini +41 -0
  45. xnn_step-2026.9.18/xnn_step/installer.py +99 -0
  46. xnn_step-2026.9.18/xnn_step/metadata.py +145 -0
  47. xnn_step-2026.9.18/xnn_step/tk_xnn.py +209 -0
  48. xnn_step-2026.9.18/xnn_step/xnn.py +101 -0
  49. xnn_step-2026.9.18/xnn_step/xnn_parameters.py +40 -0
  50. xnn_step-2026.9.18/xnn_step/xnn_step.py +459 -0
  51. xnn_step-2026.9.18/xnn_step.egg-info/PKG-INFO +125 -0
  52. xnn_step-2026.9.18/xnn_step.egg-info/SOURCES.txt +56 -0
  53. xnn_step-2026.9.18/xnn_step.egg-info/dependency_links.txt +1 -0
  54. xnn_step-2026.9.18/xnn_step.egg-info/entry_points.txt +5 -0
  55. xnn_step-2026.9.18/xnn_step.egg-info/requires.txt +4 -0
  56. xnn_step-2026.9.18/xnn_step.egg-info/top_level.txt +1 -0
  57. xnn_step-2026.9.18/xnn_step.egg-info/zip-safe +1 -0
@@ -0,0 +1,5 @@
1
+ Development Team
2
+ ----------------
3
+
4
+ * Paul Saxe <psaxe@molssi.org> (Lead)
5
+ * Why don't you join the team? Become a contributor!
@@ -0,0 +1,113 @@
1
+ .. highlight:: shell
2
+
3
+ ============
4
+ Contributing
5
+ ============
6
+
7
+ Contributions are welcome, and they are greatly appreciated! Every
8
+ little bit helps, and credit will always be given.
9
+
10
+ You can contribute in many ways:
11
+
12
+ Types of Contributions
13
+ ----------------------
14
+
15
+ Report Bugs
16
+ ~~~~~~~~~~~
17
+
18
+ Report bugs at https://github.com/molssi-seamm/xnn_step/issues.
19
+
20
+ If you are reporting a bug, please include:
21
+
22
+ * Your operating system name and version.
23
+ * Any details about your local setup that might be helpful in troubleshooting.
24
+ * Detailed steps to reproduce the bug.
25
+
26
+ Fix Bugs
27
+ ~~~~~~~~
28
+
29
+ Look through the GitHub issues for bugs. Anything tagged with "bug"
30
+ and "help wanted" is open to whoever wants to implement it.
31
+
32
+ Implement Features
33
+ ~~~~~~~~~~~~~~~~~~
34
+
35
+ Look through the GitHub issues for features. Anything tagged with "enhancement"
36
+ and "help wanted" is open to whoever wants to implement it.
37
+
38
+ Write Documentation
39
+ ~~~~~~~~~~~~~~~~~~~
40
+
41
+ xnn Step could always use more documentation, whether as part of the
42
+ official xnn Step docs, in docstrings, or even on the web in blog posts,
43
+ articles, and such.
44
+
45
+ Submit Feedback
46
+ ~~~~~~~~~~~~~~~
47
+
48
+ The best way to send feedback is to file an issue at https://github.com/molssi-seamm/xnn_step/issues.
49
+
50
+ If you are proposing a feature:
51
+
52
+ * Explain in detail how it would work.
53
+ * Keep the scope as narrow as possible, to make it easier to implement.
54
+ * Remember that this is a volunteer-driven project, and that contributions
55
+ are welcome :)
56
+
57
+ Get Started!
58
+ ------------
59
+
60
+ Ready to contribute? Here's how to set up `xnn_step` for local development.
61
+
62
+ 1. Fork the `xnn_step` repo on GitHub.
63
+ 2. Clone your fork locally::
64
+
65
+ $ git clone git@github.com:your_name_here/xnn_step.git
66
+
67
+ 3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
68
+
69
+ $ mkvirtualenv xnn_step
70
+ $ cd xnn_step/
71
+ $ python setup.py develop
72
+
73
+ 4. Create a branch for local development::
74
+
75
+ $ git checkout -b name-of-your-bugfix-or-feature
76
+
77
+ Now you can make your changes locally.
78
+
79
+ 5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
80
+
81
+ $ flake8 xnn_step tests
82
+ $ python setup.py test or py.test
83
+ $ tox
84
+
85
+ To get flake8 and tox, just pip install them into your virtualenv.
86
+
87
+ 6. Commit your changes and push your branch to GitHub::
88
+
89
+ $ git add .
90
+ $ git commit -m "Your detailed description of your changes."
91
+ $ git push origin name-of-your-bugfix-or-feature
92
+
93
+ 7. Submit a pull request through the GitHub website.
94
+
95
+ Pull Request Guidelines
96
+ -----------------------
97
+
98
+ Before you submit a pull request, check that it meets these guidelines:
99
+
100
+ 1. The pull request should include tests.
101
+ 2. If the pull request adds functionality, the docs should be updated. Put
102
+ your new functionality into a function with a docstring, and add the
103
+ feature to the list in README.rst.
104
+ 3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check
105
+ https://travis-ci.org/molssi-seamm/xnn_step/pull_requests
106
+ and make sure that the tests pass for all supported Python versions.
107
+
108
+ Tips
109
+ ----
110
+
111
+ To run a subset of tests::
112
+
113
+ $ py.test tests.test_xnn_step
@@ -0,0 +1,12 @@
1
+ =======
2
+ History
3
+ =======
4
+
5
+ 2026.9.18 (2026-09-18)
6
+ ----------------------
7
+
8
+ * Initial release. Provides xnn machine-learned force fields as ``xnn:MLFF@<model>``
9
+ model chemistries (checkpoints discovered from the directories in ``xnn.ini``) and
10
+ launches ``xnn mdi`` as the MDI engine for the Energy, LAMMPS and other MDI-driving
11
+ steps. Includes ``xnn-step-installer`` for the ``seamm-xnn`` conda environment.
12
+ * Plug-in created using the SEAMM plug-in cookiecutter.
@@ -0,0 +1,31 @@
1
+
2
+ BSD 3-Clause License
3
+
4
+ Copyright (c) 2026, Paul Saxe
5
+ All rights reserved.
6
+
7
+ Redistribution and use in source and binary forms, with or without
8
+ modification, are permitted provided that the following conditions are met:
9
+
10
+ 1. Redistributions of source code must retain the above copyright notice, this
11
+ list of conditions and the following disclaimer.
12
+
13
+ 2. Redistributions in binary form must reproduce the above copyright notice,
14
+ this list of conditions and the following disclaimer in the documentation
15
+ and/or other materials provided with the distribution.
16
+
17
+ 3. Neither the name of the copyright holder nor the names of its
18
+ contributors may be used to endorse or promote products derived from
19
+ this software without specific prior written permission.
20
+
21
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24
+ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
25
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28
+ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29
+ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31
+
@@ -0,0 +1,14 @@
1
+ include AUTHORS.rst
2
+ include CONTRIBUTING.rst
3
+ include HISTORY.rst
4
+ include LICENSE
5
+ include README.rst
6
+ include requirements*
7
+ include versioneer.py
8
+
9
+ recursive-include xnn_step/data *
10
+ recursive-include tests *
11
+ recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif
12
+
13
+ recursive-exclude * __pycache__
14
+ recursive-exclude * *.py[co]
@@ -0,0 +1,125 @@
1
+ Metadata-Version: 2.4
2
+ Name: xnn_step
3
+ Version: 2026.9.18
4
+ Summary: A SEAMM plug-in for xnn
5
+ Home-page: https://github.com/molssi-seamm/xnn_step
6
+ Author: Paul Saxe
7
+ Author-email: psaxe@molssi.org
8
+ License: BSD-3-Clause
9
+ Keywords: SEAMM,SEAMMplugin,flowchart
10
+ Platform: Linux
11
+ Platform: Mac OS-X
12
+ Platform: Unix
13
+ Platform: Windows
14
+ Classifier: Environment :: Plugins
15
+ Classifier: Development Status :: 2 - Pre-Alpha
16
+ Classifier: Intended Audience :: Science/Research
17
+ Classifier: Topic :: Scientific/Engineering :: Chemistry
18
+ Classifier: Topic :: Scientific/Engineering :: Physics
19
+ Classifier: License :: OSI Approved :: BSD License
20
+ Classifier: Natural Language :: English
21
+ Classifier: Programming Language :: Python :: 3 :: Only
22
+ Classifier: Programming Language :: Python :: 3.8
23
+ Classifier: Programming Language :: Python :: 3.9
24
+ Description-Content-Type: text/x-rst
25
+ License-File: LICENSE
26
+ License-File: AUTHORS.rst
27
+ Requires-Dist: seamm
28
+ Requires-Dist: seamm-installer
29
+ Requires-Dist: seamm-util
30
+ Requires-Dist: seamm-widgets
31
+ Dynamic: author
32
+ Dynamic: author-email
33
+ Dynamic: classifier
34
+ Dynamic: description
35
+ Dynamic: description-content-type
36
+ Dynamic: home-page
37
+ Dynamic: keywords
38
+ Dynamic: license
39
+ Dynamic: license-file
40
+ Dynamic: platform
41
+ Dynamic: requires-dist
42
+ Dynamic: summary
43
+
44
+ =================
45
+ SEAMM xnn Plug-in
46
+ =================
47
+
48
+ .. image:: https://img.shields.io/github/issues-pr-raw/molssi-seamm/xnn_step
49
+ :target: https://github.com/molssi-seamm/xnn_step/pulls
50
+ :alt: GitHub pull requests
51
+
52
+ .. image:: https://github.com/molssi-seamm/xnn_step/workflows/CI/badge.svg
53
+ :target: https://github.com/molssi-seamm/xnn_step/actions
54
+ :alt: Build Status
55
+
56
+ .. image:: https://codecov.io/gh/molssi-seamm/xnn_step/branch/master/graph/badge.svg
57
+ :target: https://codecov.io/gh/molssi-seamm/xnn_step
58
+ :alt: Code Coverage
59
+
60
+ .. image:: https://github.com/molssi-seamm/xnn_step/workflows/CodeQL/badge.svg
61
+ :target: https://github.com/molssi-seamm/xnn_step/security/code-scanning
62
+ :alt: Code Quality
63
+
64
+ .. image:: https://github.com/molssi-seamm/xnn_step/workflows/Release/badge.svg
65
+ :target: https://molssi-seamm.github.io/xnn_step/index.html
66
+ :alt: Documentation Status
67
+
68
+ .. image:: https://img.shields.io/pypi/v/xnn_step.svg
69
+ :target: https://pypi.python.org/pypi/xnn_step
70
+ :alt: PyPi VERSION
71
+
72
+ A SEAMM plug-in providing machine-learned force fields (MLFFs) trained with `xnn`_ as
73
+ model chemistries, run as MDI engines.
74
+
75
+ * Free software: BSD-3-Clause
76
+ * Documentation: https://molssi-seamm.github.io/xnn_step/index.html
77
+ * Code: https://github.com/molssi-seamm/xnn_step
78
+
79
+ Features
80
+ --------
81
+
82
+ * Advertises every xnn checkpoint found in the directories listed in ``xnn.ini`` to
83
+ the Model Chemistry step as ``xnn:MLFF@<model>``.
84
+ * Launches ``xnn mdi`` -- the checkpoint served as a resident MDI engine -- for any step
85
+ that drives a model chemistry over MDI: Energy (single points for many structures),
86
+ LAMMPS (MD with the MLFF as the QM engine), Dimer Builder, Normal Mode Sampling.
87
+ * Molecular and periodic systems (energy, forces and stress); runs on the CPU or a GPU
88
+ (``device`` in ``xnn.ini``).
89
+ * There is no xnn step to place in a flowchart: the models are used through
90
+ Model Chemistry + Energy (or LAMMPS).
91
+
92
+ .. _xnn: https://github.com/molssi-ai/xnn
93
+
94
+ Note: xnn is published on PyPI under the name ``xnns``; the import name and the ``xnn``
95
+ command are unchanged.
96
+
97
+ Acknowledgements
98
+ ----------------
99
+
100
+ This package was created with the `molssi-seamm/cookiecutter-seamm-plugin`_ tool, which
101
+ is based on the excellent Cookiecutter_.
102
+
103
+ .. _Cookiecutter: https://github.com/audreyr/cookiecutter
104
+ .. _`molssi-seamm/cookiecutter-seamm-plugin`: https://github.com/molssi-seamm/cookiecutter-seamm-plugin
105
+
106
+ Developed by the Molecular Sciences Software Institute (MolSSI_),
107
+ which receives funding from the `National Science Foundation`_ under
108
+ award CHE-2136142.
109
+
110
+ .. _MolSSI: https://molssi.org
111
+ .. _`National Science Foundation`: https://www.nsf.gov
112
+
113
+
114
+ =======
115
+ History
116
+ =======
117
+
118
+ 2026.9.18 (2026-09-18)
119
+ ----------------------
120
+
121
+ * Initial release. Provides xnn machine-learned force fields as ``xnn:MLFF@<model>``
122
+ model chemistries (checkpoints discovered from the directories in ``xnn.ini``) and
123
+ launches ``xnn mdi`` as the MDI engine for the Energy, LAMMPS and other MDI-driving
124
+ steps. Includes ``xnn-step-installer`` for the ``seamm-xnn`` conda environment.
125
+ * Plug-in created using the SEAMM plug-in cookiecutter.
@@ -0,0 +1,68 @@
1
+ =================
2
+ SEAMM xnn Plug-in
3
+ =================
4
+
5
+ .. image:: https://img.shields.io/github/issues-pr-raw/molssi-seamm/xnn_step
6
+ :target: https://github.com/molssi-seamm/xnn_step/pulls
7
+ :alt: GitHub pull requests
8
+
9
+ .. image:: https://github.com/molssi-seamm/xnn_step/workflows/CI/badge.svg
10
+ :target: https://github.com/molssi-seamm/xnn_step/actions
11
+ :alt: Build Status
12
+
13
+ .. image:: https://codecov.io/gh/molssi-seamm/xnn_step/branch/master/graph/badge.svg
14
+ :target: https://codecov.io/gh/molssi-seamm/xnn_step
15
+ :alt: Code Coverage
16
+
17
+ .. image:: https://github.com/molssi-seamm/xnn_step/workflows/CodeQL/badge.svg
18
+ :target: https://github.com/molssi-seamm/xnn_step/security/code-scanning
19
+ :alt: Code Quality
20
+
21
+ .. image:: https://github.com/molssi-seamm/xnn_step/workflows/Release/badge.svg
22
+ :target: https://molssi-seamm.github.io/xnn_step/index.html
23
+ :alt: Documentation Status
24
+
25
+ .. image:: https://img.shields.io/pypi/v/xnn_step.svg
26
+ :target: https://pypi.python.org/pypi/xnn_step
27
+ :alt: PyPi VERSION
28
+
29
+ A SEAMM plug-in providing machine-learned force fields (MLFFs) trained with `xnn`_ as
30
+ model chemistries, run as MDI engines.
31
+
32
+ * Free software: BSD-3-Clause
33
+ * Documentation: https://molssi-seamm.github.io/xnn_step/index.html
34
+ * Code: https://github.com/molssi-seamm/xnn_step
35
+
36
+ Features
37
+ --------
38
+
39
+ * Advertises every xnn checkpoint found in the directories listed in ``xnn.ini`` to
40
+ the Model Chemistry step as ``xnn:MLFF@<model>``.
41
+ * Launches ``xnn mdi`` -- the checkpoint served as a resident MDI engine -- for any step
42
+ that drives a model chemistry over MDI: Energy (single points for many structures),
43
+ LAMMPS (MD with the MLFF as the QM engine), Dimer Builder, Normal Mode Sampling.
44
+ * Molecular and periodic systems (energy, forces and stress); runs on the CPU or a GPU
45
+ (``device`` in ``xnn.ini``).
46
+ * There is no xnn step to place in a flowchart: the models are used through
47
+ Model Chemistry + Energy (or LAMMPS).
48
+
49
+ .. _xnn: https://github.com/molssi-ai/xnn
50
+
51
+ Note: xnn is published on PyPI under the name ``xnns``; the import name and the ``xnn``
52
+ command are unchanged.
53
+
54
+ Acknowledgements
55
+ ----------------
56
+
57
+ This package was created with the `molssi-seamm/cookiecutter-seamm-plugin`_ tool, which
58
+ is based on the excellent Cookiecutter_.
59
+
60
+ .. _Cookiecutter: https://github.com/audreyr/cookiecutter
61
+ .. _`molssi-seamm/cookiecutter-seamm-plugin`: https://github.com/molssi-seamm/cookiecutter-seamm-plugin
62
+
63
+ Developed by the Molecular Sciences Software Institute (MolSSI_),
64
+ which receives funding from the `National Science Foundation`_ under
65
+ award CHE-2136142.
66
+
67
+ .. _MolSSI: https://molssi.org
68
+ .. _`National Science Foundation`: https://www.nsf.gov
@@ -0,0 +1,177 @@
1
+ # Makefile for Sphinx documentation
2
+ #
3
+
4
+ # You can set these variables from the command line.
5
+ SPHINXOPTS =
6
+ SPHINXBUILD = sphinx-build
7
+ PAPER =
8
+ BUILDDIR = _build
9
+
10
+ # User-friendly check for sphinx-build
11
+ ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
12
+ $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
13
+ endif
14
+
15
+ # Internal variables.
16
+ PAPEROPT_a4 = -D latex_paper_size=a4
17
+ PAPEROPT_letter = -D latex_paper_size=letter
18
+ ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
19
+ # the i18n builder cannot share the environment and doctrees with the others
20
+ I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
21
+
22
+ .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
23
+
24
+ help:
25
+ @echo "Please use \`make <target>' where <target> is one of"
26
+ @echo " html to make standalone HTML files"
27
+ @echo " dirhtml to make HTML files named index.html in directories"
28
+ @echo " singlehtml to make a single large HTML file"
29
+ @echo " pickle to make pickle files"
30
+ @echo " json to make JSON files"
31
+ @echo " htmlhelp to make HTML files and a HTML help project"
32
+ @echo " qthelp to make HTML files and a qthelp project"
33
+ @echo " devhelp to make HTML files and a Devhelp project"
34
+ @echo " epub to make an epub"
35
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
36
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
37
+ @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
38
+ @echo " text to make text files"
39
+ @echo " man to make manual pages"
40
+ @echo " texinfo to make Texinfo files"
41
+ @echo " info to make Texinfo files and run them through makeinfo"
42
+ @echo " gettext to make PO message catalogs"
43
+ @echo " changes to make an overview of all changed/added/deprecated items"
44
+ @echo " xml to make Docutils-native XML files"
45
+ @echo " pseudoxml to make pseudoxml-XML files for display purposes"
46
+ @echo " linkcheck to check all external links for integrity"
47
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
48
+
49
+ clean:
50
+ rm -rf $(BUILDDIR)/*
51
+
52
+ html:
53
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
54
+ @echo
55
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
56
+
57
+ dirhtml:
58
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
59
+ @echo
60
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
61
+
62
+ singlehtml:
63
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
64
+ @echo
65
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
66
+
67
+ pickle:
68
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
69
+ @echo
70
+ @echo "Build finished; now you can process the pickle files."
71
+
72
+ json:
73
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
74
+ @echo
75
+ @echo "Build finished; now you can process the JSON files."
76
+
77
+ htmlhelp:
78
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
79
+ @echo
80
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
81
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
82
+
83
+ qthelp:
84
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
85
+ @echo
86
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
87
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
88
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/xnn_step.qhcp"
89
+ @echo "To view the help file:"
90
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/xnn_step.qhc"
91
+
92
+ devhelp:
93
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
94
+ @echo
95
+ @echo "Build finished."
96
+ @echo "To view the help file:"
97
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/xnn_step"
98
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/xnn_step"
99
+ @echo "# devhelp"
100
+
101
+ epub:
102
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
103
+ @echo
104
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
105
+
106
+ latex:
107
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
108
+ @echo
109
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
110
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
111
+ "(use \`make latexpdf' here to do that automatically)."
112
+
113
+ latexpdf:
114
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
115
+ @echo "Running LaTeX files through pdflatex..."
116
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
117
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
118
+
119
+ latexpdfja:
120
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
121
+ @echo "Running LaTeX files through platex and dvipdfmx..."
122
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
123
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
124
+
125
+ text:
126
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
127
+ @echo
128
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
129
+
130
+ man:
131
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
132
+ @echo
133
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
134
+
135
+ texinfo:
136
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
137
+ @echo
138
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
139
+ @echo "Run \`make' in that directory to run these through makeinfo" \
140
+ "(use \`make info' here to do that automatically)."
141
+
142
+ info:
143
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
144
+ @echo "Running Texinfo files through makeinfo..."
145
+ make -C $(BUILDDIR)/texinfo info
146
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
147
+
148
+ gettext:
149
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
150
+ @echo
151
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
152
+
153
+ changes:
154
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
155
+ @echo
156
+ @echo "The overview file is in $(BUILDDIR)/changes."
157
+
158
+ linkcheck:
159
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
160
+ @echo
161
+ @echo "Link check complete; look for any errors in the above output " \
162
+ "or in $(BUILDDIR)/linkcheck/output.txt."
163
+
164
+ doctest:
165
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
166
+ @echo "Testing of doctests in the sources finished, look at the " \
167
+ "results in $(BUILDDIR)/doctest/output.txt."
168
+
169
+ xml:
170
+ $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
171
+ @echo
172
+ @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
173
+
174
+ pseudoxml:
175
+ $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
176
+ @echo
177
+ @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
Binary file
@@ -0,0 +1,17 @@
1
+ API Documentation
2
+ =================
3
+
4
+ Contents:
5
+
6
+ .. toctree::
7
+ :maxdepth: 2
8
+
9
+ modules
10
+
11
+
12
+ Indices and tables
13
+ ------------------
14
+
15
+ * :ref:`genindex`
16
+ * :ref:`modindex`
17
+ * :ref:`search`
@@ -0,0 +1 @@
1
+ .. include:: ../AUTHORS.rst