Skip to content

Commit 77f54db

Browse files
committed
Merge pull request #915 from Akasurde/issue-890
Converted docs from txt to rst
2 parents 2bbe709 + ab9befb commit 77f54db

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

102 files changed

+54
-51
lines changed

AUTHORS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ merlinux GmbH, Germany, office at merlinux eu
33

44
Contributors include::
55

6+
Abhijeet Kasurde
67
Anatoly Bubenkoff
78
Andreas Zeidler
89
Andy Freeland

CHANGELOG

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,8 @@
120120

121121
- add ``file`` and ``line`` attributes to JUnit-XML output.
122122

123+
- converted all txt documentation to rst format.
124+
123125
2.7.3 (compared to 2.7.2)
124126
-----------------------------
125127

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ clean:
2121

2222
# generate documentation
2323
docs: develop
24-
find doc/en -name '*.txt' -not -path 'doc/en/_build/*' | xargs .env/bin/regendoc ${REGENDOC_ARGS}
24+
find doc/en -name '*.rst' -not -path 'doc/en/_build/*' | xargs .env/bin/regendoc ${REGENDOC_ARGS}
2525
cd doc/en; make html
2626

2727
# upload documentation
2828
upload-docs: develop
29-
find doc/en -name '*.txt' -not -path 'doc/en/_build/*' | xargs .env/bin/regendoc ${REGENDOC_ARGS} --update
29+
find doc/en -name '*.rst' -not -path 'doc/en/_build/*' | xargs .env/bin/regendoc ${REGENDOC_ARGS} --update
3030
#cd doc/en; make install
3131

doc/en/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ installall: clean install installpdf
4646
@echo "done"
4747

4848
regen:
49-
PYTHONDONTWRITEBYTECODE=1 COLUMNS=76 regendoc --update *.txt */*.txt
49+
PYTHONDONTWRITEBYTECODE=1 COLUMNS=76 regendoc --update *.rst */*.rst
5050

5151
html:
5252
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

doc/en/apiref.rst

Lines changed: 27 additions & 0 deletions

doc/en/apiref.txt

Lines changed: 0 additions & 27 deletions
This file was deleted.

doc/en/conf.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
templates_path = ['_templates']
4848

4949
# The suffix of source filenames.
50-
source_suffix = '.txt'
50+
source_suffix = '.rst'
5151

5252
# The encoding of source files.
5353
#source_encoding = 'utf-8-sig'
@@ -73,13 +73,13 @@
7373

7474
# List of patterns, relative to source directory, that match files and
7575
# directories to ignore when looking for source files.
76-
exclude_patterns = ['links.inc', '_build', 'naming20.txt', 'test/*',
76+
exclude_patterns = ['links.inc', '_build', 'naming20.rst', 'test/*',
7777
"old_*",
7878
'*attic*',
7979
'*/attic*',
80-
'funcargs.txt',
81-
'setup.txt',
82-
'example/remoteinterp.txt',
80+
'funcargs.rst',
81+
'setup.rst',
82+
'example/remoteinterp.rst',
8383
]
8484

8585

doc/en/contents.txt renamed to doc/en/contents.rst

Lines changed: 2 additions & 2 deletions

doc/en/example/index.txt renamed to doc/en/example/index.rst

Lines changed: 7 additions & 7 deletions

doc/en/goodpractises.txt renamed to doc/en/goodpractises.rst

Lines changed: 1 addition & 1 deletion

doc/en/overview.txt renamed to doc/en/overview.rst

Lines changed: 6 additions & 6 deletions

0 commit comments

Comments
 (0)