Skip to content

Commit 8d1dafb

Browse files
committed
rst-md.
1 parent 4d8fbaa commit 8d1dafb

30 files changed

+38
-291
lines changed
File renamed without changes.
File renamed without changes.
File renamed without changes.

MAKE_RELEASE.rst renamed to MAKE_RELEASE.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ Prepare/make release on dev.
1111
* Make pull request "prepare v3.5.x", with the following:
1212
* Update pymodbus/__init__.py with version number (__version__ X.Y.Zpre)
1313
* Update README.rst "Supported versions"
14-
* Control / Update API_changes.rst
15-
* Update CHANGELOG.rst
14+
* Control / Update API_changes.md
15+
* Update CHANGELOG.md
1616
* Add commits from last release, but selectively !
1717
git log --oneline v3.5.3..HEAD > commit.log
1818
git log --pretty="%an" v3.0.0..HEAD | sort -uf > authors.log

MANIFEST.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
include pyproject.toml
22
include README.md
3-
include CHANGELOG.rst
3+
include CHANGELOG.md
44
include LICENSE

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Important
5757
:::
5858

5959
All API changes after 3.0.0 are documented in
60-
[API_changes.rst](https://github.com/pymodbus-dev/pymodbus/blob/dev/CHANGELOG.rst)
60+
[API_changes.md](https://github.com/pymodbus-dev/pymodbus/blob/dev/CHANGELOG.md)
6161
:::
6262

6363
## Common features

README.rst

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

doc/conf.py

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,17 @@
2020
github_doc_root = "https://github.com/pymodbus-dev/pymodbus/tree/master/doc/"
2121

2222
# -- General configuration ------------------------------------------------
23-
extensions = ["sphinx.ext.autodoc", "sphinx_rtd_theme", "sphinx.ext.autosectionlabel"]
24-
source_suffix = [".rst"]
23+
extensions = [
24+
"sphinx.ext.autodoc",
25+
"sphinx_rtd_theme",
26+
"sphinx.ext.autosectionlabel",
27+
"myst_parser"
28+
]
29+
source_suffix = {
30+
'.rst': 'restructuredtext',
31+
'.txt': 'markdown',
32+
'.md': 'markdown',
33+
}
2534
master_doc = "index"
2635
project = "PyModbus"
2736
copyright = "See license"

doc/index.rst

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,19 @@ Welcome to PyModbus's documentation!
55
:maxdepth: 8
66
:caption: Contents:
77

8-
source/readme.rst
9-
source/client.rst
10-
source/library/server.rst
11-
source/library/nullmodem.rst
8+
source/readme
9+
source/client
10+
source/library/server
11+
source/library/nullmodem
1212
source/library/simulator/simulator
13+
source/library/simulator/config
14+
source/library/simulator/datastore
15+
source/library/simulator/restapi
16+
source/library/simulator/web
1317
source/library/REPL
14-
source/library/datastore.rst
15-
source/library/framer.rst
16-
source/library/constants.rst
17-
source/library/pymodbus.rst
18-
source/examples.rst
19-
source/authors.rst
18+
source/library/datastore
19+
source/library/framer
20+
source/library/constants
21+
source/library/pymodbus
22+
source/examples
23+
source/authors

doc/source/_static/examples.tgz

-58 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)