Skip to content

Commit 9ad3ccd

Browse files
author
Julia Wellmann
committed
Updating documentation from jube2 to jube
1 parent 474628c commit 9ad3ccd

File tree

9 files changed

+68
-68
lines changed

9 files changed

+68
-68
lines changed

‎docs/Makefile‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ help:
3737
@echo " changes to make an overview of all changed/added/deprecated items"
3838
@echo " linkcheck to check all external links for integrity"
3939
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
40-
@echo " update_help to update the help.txt file under jube2"
40+
@echo " update_help to update the help.txt file under jube"
4141
@echo " update_release to update the release notes file RELEASE_NOTES"
4242

4343
clean:
@@ -79,17 +79,17 @@ qthelp:
7979
@echo
8080
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
8181
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
82-
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/JUBE2.qhcp"
82+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/JUBE.qhcp"
8383
@echo "To view the help file:"
84-
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/JUBE2.qhc"
84+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/JUBE.qhc"
8585

8686
devhelp:
8787
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
8888
@echo
8989
@echo "Build finished."
9090
@echo "To view the help file:"
91-
@echo "# mkdir -p $$HOME/.local/share/devhelp/JUBE2"
92-
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/JUBE2"
91+
@echo "# mkdir -p $$HOME/.local/share/devhelp/JUBE"
92+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/JUBE"
9393
@echo "# devhelp"
9494

9595
epub:
@@ -117,7 +117,7 @@ text:
117117
@echo "Build finished. The text files are in $(BUILDDIR)/text."
118118

119119
update_help: text
120-
cp $(BUILDDIR)/text/glossar.txt ../jube2/help.txt
120+
cp $(BUILDDIR)/text/glossar.txt ../jube/help.txt
121121

122122
update_release: text
123123
cp $(BUILDDIR)/text/release_notes.txt ../RELEASE_NOTES

‎docs/conf.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
# You should have received a copy of the GNU General Public License
1818
# along with this program. If not, see <http://www.gnu.org/licenses/>.
1919
#
20-
# JUBE2 documentation build configuration file, created by
20+
# JUBE documentation build configuration file, created by
2121
# sphinx-quickstart on Thu Apr 17 18:09:51 2014.
2222
#
2323
# This file is execfile()d with the current directory set to its containing dir.
@@ -87,7 +87,7 @@
8787
# directories to ignore when looking for source files.
8888
exclude_patterns = ['_build']
8989
if tags.has('latex'):
90-
exclude_patterns += ['index.rst','jube2.rst','devel.rst']
90+
exclude_patterns += ['index.rst','jube.rst','devel.rst']
9191
else:
9292
exclude_patterns += ['index_user.rst']
9393

‎docs/devel.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ In the top directory
6666

6767
.. code-block:: sh
6868
69-
pylint --rcfile devel-utils/pylint.rc jube2
69+
pylint --rcfile devel-utils/pylint.rc jube
7070
7171
7272
Flake8
@@ -76,7 +76,7 @@ In the top directory
7676

7777
.. code-block:: sh
7878
79-
flake8 --config devel-utils/flake8 jube2
79+
flake8 --config devel-utils/flake8 jube
8080
8181
Another possibility is to copy or link the file to the default search
8282
path ``~/.config/flake8`` to use it globally.
@@ -129,4 +129,4 @@ to update the ``tar.gz`` file inside the dist directory.
129129
Python package documentation
130130
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
131131

132-
Here you will find the *Python* package documentation of *JUBE*: :doc:`Package doku <jube2>`
132+
Here you will find the *Python* package documentation of *JUBE*: :doc:`Package doku <jube>`

‎docs/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,4 @@ Contents:
3636
.. toctree::
3737
:hidden:
3838

39-
jube2
39+
jube

docs/jube2.result_types.rst renamed to docs/jube.result_types.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
1-
jube2\.result\_types package
1+
jube\.result\_types package
22
============================
33

4-
.. automodule:: jube2.result_types
4+
.. automodule:: jube.result_types
55
:members:
66
:undoc-members:
77
:show-inheritance:
88

99
Submodules
1010
----------
1111

12-
jube2\.result\_types\.keyvaluesresult module
12+
jube\.result\_types\.keyvaluesresult module
1313
--------------------------------------------
1414

15-
.. automodule:: jube2.result_types.keyvaluesresult
15+
.. automodule:: jube.result_types.keyvaluesresult
1616
:members:
1717
:undoc-members:
1818
:show-inheritance:
1919

20-
jube2\.result\_types\.syslog module
20+
jube\.result\_types\.syslog module
2121
-----------------------------------
2222

23-
.. automodule:: jube2.result_types.syslog
23+
.. automodule:: jube.result_types.syslog
2424
:members:
2525
:undoc-members:
2626
:show-inheritance:
2727

28-
jube2\.result\_types\.table module
28+
jube\.result\_types\.table module
2929
----------------------------------
3030

31-
.. automodule:: jube2.result_types.table
31+
.. automodule:: jube.result_types.table
3232
:members:
3333
:undoc-members:
3434
:show-inheritance:

docs/jube2.rst renamed to docs/jube.rst

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
jube2 package
1+
jube package
22
=============
33

4-
.. automodule:: jube2
4+
.. automodule:: jube
55
:members:
66
:undoc-members:
77
:show-inheritance:
@@ -11,136 +11,136 @@ Subpackages
1111

1212
.. toctree::
1313

14-
jube2.result_types
15-
jube2.util
14+
jube.result_types
15+
jube.util
1616

1717
Submodules
1818
----------
1919

20-
jube2\.analyser module
20+
jube\.analyser module
2121
----------------------
2222

23-
.. automodule:: jube2.analyser
23+
.. automodule:: jube.analyser
2424
:members:
2525
:undoc-members:
2626
:show-inheritance:
2727

28-
jube2\.benchmark module
28+
jube\.benchmark module
2929
-----------------------
3030

31-
.. automodule:: jube2.benchmark
31+
.. automodule:: jube.benchmark
3232
:members:
3333
:undoc-members:
3434
:show-inheritance:
3535

36-
jube2\.completion module
36+
jube\.completion module
3737
------------------------
3838

39-
.. automodule:: jube2.completion
39+
.. automodule:: jube.completion
4040
:members:
4141
:undoc-members:
4242
:show-inheritance:
4343

44-
jube2\.conf module
44+
jube\.conf module
4545
------------------
4646

47-
.. automodule:: jube2.conf
47+
.. automodule:: jube.conf
4848
:members:
4949
:undoc-members:
5050
:show-inheritance:
5151

52-
jube2\.fileset module
52+
jube\.fileset module
5353
---------------------
5454

55-
.. automodule:: jube2.fileset
55+
.. automodule:: jube.fileset
5656
:members:
5757
:undoc-members:
5858
:show-inheritance:
5959

60-
jube2\.help module
60+
jube\.help module
6161
------------------
6262

63-
.. automodule:: jube2.help
63+
.. automodule:: jube.help
6464
:members:
6565
:undoc-members:
6666
:show-inheritance:
6767

68-
jube2\.info module
68+
jube\.info module
6969
------------------
7070

71-
.. automodule:: jube2.info
71+
.. automodule:: jube.info
7272
:members:
7373
:undoc-members:
7474
:show-inheritance:
7575

76-
jube2\.jubeio module
76+
jube\.jubeio module
7777
--------------------
7878

79-
.. automodule:: jube2.jubeio
79+
.. automodule:: jube.jubeio
8080
:members:
8181
:undoc-members:
8282
:show-inheritance:
8383

84-
jube2\.log module
84+
jube\.log module
8585
-----------------
8686

87-
.. automodule:: jube2.log
87+
.. automodule:: jube.log
8888
:members:
8989
:undoc-members:
9090
:show-inheritance:
9191

92-
jube2\.main module
92+
jube\.main module
9393
------------------
9494

95-
.. automodule:: jube2.main
95+
.. automodule:: jube.main
9696
:members:
9797
:undoc-members:
9898
:show-inheritance:
9999

100-
jube2\.parameter module
100+
jube\.parameter module
101101
-----------------------
102102

103-
.. automodule:: jube2.parameter
103+
.. automodule:: jube.parameter
104104
:members:
105105
:undoc-members:
106106
:show-inheritance:
107107

108-
jube2\.pattern module
108+
jube\.pattern module
109109
---------------------
110110

111-
.. automodule:: jube2.pattern
111+
.. automodule:: jube.pattern
112112
:members:
113113
:undoc-members:
114114
:show-inheritance:
115115

116-
jube2\.result module
116+
jube\.result module
117117
--------------------
118118

119-
.. automodule:: jube2.result
119+
.. automodule:: jube.result
120120
:members:
121121
:undoc-members:
122122
:show-inheritance:
123123

124-
jube2\.step module
124+
jube\.step module
125125
------------------
126126

127-
.. automodule:: jube2.step
127+
.. automodule:: jube.step
128128
:members:
129129
:undoc-members:
130130
:show-inheritance:
131131

132-
jube2\.substitute module
132+
jube\.substitute module
133133
------------------------
134134

135-
.. automodule:: jube2.substitute
135+
.. automodule:: jube.substitute
136136
:members:
137137
:undoc-members:
138138
:show-inheritance:
139139

140-
jube2\.workpackage module
140+
jube\.workpackage module
141141
-------------------------
142142

143-
.. automodule:: jube2.workpackage
143+
.. automodule:: jube.workpackage
144144
:members:
145145
:undoc-members:
146146
:show-inheritance:

docs/jube2.util.rst renamed to docs/jube.util.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
1-
jube2\.util package
1+
jube\.util package
22
===================
33

4-
.. automodule:: jube2.util
4+
.. automodule:: jube.util
55
:members:
66
:undoc-members:
77
:show-inheritance:
88

99
Submodules
1010
----------
1111

12-
jube2\.util\.output module
12+
jube\.util\.output module
1313
--------------------------
1414

15-
.. automodule:: jube2.util.output
15+
.. automodule:: jube.util.output
1616
:members:
1717
:undoc-members:
1818
:show-inheritance:
1919

20-
jube2\.util\.util module
20+
jube\.util\.util module
2121
------------------------
2222

23-
.. automodule:: jube2.util.util
23+
.. automodule:: jube.util.util
2424
:members:
2525
:undoc-members:
2626
:show-inheritance:
2727

28-
jube2\.util\.yaml\_converter module
28+
jube\.util\.yaml\_converter module
2929
-----------------------------------
3030

31-
.. automodule:: jube2.util.yaml_converter
31+
.. automodule:: jube.util.yaml_converter
3232
:members:
3333
:undoc-members:
3434
:show-inheritance:

‎docs/tutorial.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,13 +48,13 @@ To use the *JUBE* command line tool, the ``PYTHONPATH`` must contain the positio
4848

4949
* You can utilize ``pip[3]`` to take care of the installation process (including the download) ::
5050

51-
>>> pip3 install http://apps.fz-juelich.de/jsc/jube/jube2/download.php?version=latest --user
51+
>>> pip3 install http://apps.fz-juelich.de/jsc/jube/jube/download.php?version=latest --user
5252
# or
53-
>>> pip3 install http://apps.fz-juelich.de/jsc/jube/jube2/download.php?version=latest --prefix=...
53+
>>> pip3 install http://apps.fz-juelich.de/jsc/jube/jube/download.php?version=latest --prefix=...
5454

5555
You might have to adjust your ``PYTHONPATH``.
5656

57-
* You can add the **parent folder path** of the *JUBE* package-folder (``jube2`` directory) to the ``PYTHONPATH`` environment variable::
57+
* You can add the **parent folder path** of the *JUBE* package-folder (``jube`` directory) to the ``PYTHONPATH`` environment variable::
5858

5959
>>> export PYTHONPATH=<parent folder path>:$PYTHONPATH
6060

‎docs/update_python_docu.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
#!/bin/sh
2-
sphinx-apidoc -f -T -M -o . ../jube2/
2+
sphinx-apidoc -f -T -M -o . ../jube/

0 commit comments

Comments
 (0)