Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
P
ProMod3
Manage
Activity
Members
Plan
Jira
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Container registry
Model registry
Analyze
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
schwede
ProMod3
Commits
76582859
Commit
76582859
authored
9 years ago
by
Bienchen
Browse files
Options
Downloads
Patches
Plain Diff
Added documentation
parent
28d96e27
No related branches found
No related tags found
No related merge requests found
Changes
4
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
core/doc/CMakeLists.txt
+1
-0
1 addition, 0 deletions
core/doc/CMakeLists.txt
core/doc/index.rst
+3
-1
3 additions, 1 deletion
core/doc/index.rst
core/doc/pm3argparse.rst
+33
-0
33 additions, 0 deletions
core/doc/pm3argparse.rst
doc/conf.py.in
+3
-0
3 additions, 0 deletions
doc/conf.py.in
with
40 additions
and
1 deletion
core/doc/CMakeLists.txt
+
1
−
0
View file @
76582859
set
(
CORE_RST
index.rst
argcheck.rst
pm3argparse.rst
helper.rst
setcompoundschemlib.rst
)
...
...
This diff is collapsed.
Click to expand it.
core/doc/index.rst
+
3
−
1
View file @
76582859
...
...
@@ -9,7 +9,9 @@ modeling per se but cover standard programming issues.
.. toctree::
:maxdepth: 2
pm3argparse
argcheck
helper
...
...
This diff is collapsed.
Click to expand it.
core/doc/pm3argparse.rst
0 → 100644
+
33
−
0
View file @
76582859
:mod:`~promod3.core.pm3argparse` - Parsing Command Lines
================================================================================
.. currentmodule:: promod3.core.pm3argparse
Introduction
--------------------------------------------------------------------------------
A lot of the actions in |project| have a bunch of command line parameters/
arguments in common. For example we need an input alignment quite often and
usually for an alignment we need information on what is the target sequence,
what identifies a template sequence and eventually a hint on the format. That
means we need the same functionality on the command line in several actions.
There :class:`pm3argparse.PM3ArgumentParser` serves as a simplification. It
provides a set of standard arguments you just need to activate for your action
plus it comes with some verification functionality for input.
.. synopsis/ example
Argument Parser
--------------------------------------------------------------------------------
.. autoclass:: PM3ArgumentParser
:members:
.. automethod:: __init__
.. |descattr| replace:: :attr:`description`
.. |argpinit| replace:: :meth:`ArgumentParser.__init__`
.. |progattr| replace:: :attr:`prog`
.. LocalWords: currentmodule argparse ArgumentParser autoclass automethod
.. LocalWords: init descattr attr argpinit meth progattr prog
This diff is collapsed.
Click to expand it.
doc/conf.py.in
+
3
−
0
View file @
76582859
...
...
@@ -286,6 +286,9 @@ rst_epilog = """
.. _ost_s: http://www.OpenStructure.org
.. _nameattr: @PYTHON_DOC_URL@/library/__main__.html
.. _mainattr: @PYTHON_DOC_URL@/library/__main__.html
.. _descattr: @PYTHON_DOC_URL@/library/argparse.html#description
.. _progattr: @PYTHON_DOC_URL@/library/argparse.html#prog
.. _argpinit: @PYTHON_DOC_URL@/library/argparse.html#argparse.ArgumentParser
.. |pep8| replace:: PEP 8
.. _pep8: https://www.python.org/dev/peps/pep-0008/
""" % project
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment