Skip to content

Commit 2795126

Browse files
committed
docs: Remove unnecessary docs.
We generated a more comprehensive README.md which should also be what is presented on PyPI. And we don't need to keep a changelog in the repo. The releases on PyPI will server as the changelog and those are now automatically generated with python-semantic-release.
1 parent 0645af2 commit 2795126

8 files changed

Lines changed: 3 additions & 178 deletions

File tree

backend/CHANGELOG.rst

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

backend/MANIFEST.in

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
include CHANGELOG.rst
21
include LICENSE.txt
3-
include README.rst
2+
include README.md
43
include requirements/base.in
54
include requirements/constraints.txt
65
recursive-include sample_plugin *.html *.png *.gif *.js *.css *.jpg *.jpeg *.svg

backend/README.rst

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

backend/docs/changelog.rst

Lines changed: 0 additions & 1 deletion
This file was deleted.

backend/docs/index.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,13 @@ Contents:
1313
.. toctree::
1414
:maxdepth: 2
1515

16-
readme
1716
getting_started
1817
quickstarts/index
1918
concepts/index
2019
how-tos/index
2120
testing
2221
internationalization
2322
modules
24-
changelog
2523
decisions
2624
references/index
2725

backend/docs/readme.rst

Lines changed: 0 additions & 1 deletion
This file was deleted.

backend/pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Homepage = "https://openedx.org/openedx/sample-plugin"
3737
Repository = "https://openedx.org/openedx/sample-plugin"
3838

3939
[tool.setuptools.dynamic]
40-
readme = {file = ["README.rst", "CHANGELOG.rst"]}
40+
readme = {file = ["README.md"], content-type = "text/markdown" }
4141
dependencies = {file = "requirements/base.in"}
4242

4343
[tool.setuptools.packages.find]

backend/tox.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ allowlist_externals =
5555
deps =
5656
-r{toxinidir}/requirements/doc.txt
5757
commands =
58-
doc8 --ignore-path docs/_build README.rst docs
58+
doc8 --ignore-path docs/_build docs
5959
rm -f docs/sample_plugin.rst
6060
rm -f docs/modules.rst
6161
make -e -C docs clean

0 commit comments

Comments
 (0)