feanil/update docs

backend/MANIFEST.in

@@ -1,6 +1,5 @@
-include CHANGELOG.rst
 include LICENSE.txt
-include README.rst
+include README.md
 include requirements/base.in
 include requirements/constraints.txt
 recursive-include sample_plugin *.html *.png *.gif *.js *.css *.jpg *.jpeg *.svg

backend/docs/index.rst

@@ -13,15 +13,13 @@ Contents:
 .. toctree::
    :maxdepth: 2
 
-   readme
    getting_started
    quickstarts/index
    concepts/index
    how-tos/index
    testing
    internationalization
    modules
-   changelog
    decisions
    references/index
 

backend/pyproject.toml

@@ -37,15 +37,25 @@ Homepage = "https://openedx.org/openedx/sample-plugin"
 Repository = "https://openedx.org/openedx/sample-plugin"
 
 [tool.setuptools.dynamic]
-readme = {file = ["README.rst", "CHANGELOG.rst"]}
+readme = {file = ["README.md"], content-type = "text/markdown" }
 dependencies = {file = "requirements/base.in"}
 
 [tool.setuptools.packages.find]
 include = ["sample_plugin*"]
 exclude = ["sample_plugin.tests*"]
 
 [tool.semantic_release]
-build_command = "pip install build && python -m build"
+# We use SETUPTOOLS_SCM_PRETEND_VERSION to pull the version from python-semantic-release instead
+# of actually pulling it from version control because the build step happens before the repo gets
+# tagged. Setuptools by default doesn't have any way of overriding the version number at build
+# time without a setup.py file.  This is a fine alternative that reduces the amount of boilerplate
+# code and files we need in this repo.
+build_command = "pip install build && SETUPTOOLS_SCM_PRETEND_VERSION=$NEW_VERSION python -m build"
+
+[tool.semantic_release.commit_parser_options]
+# Because this repo is meant to be an example, docs changes are relevant
+# feature changes and so should produces new releases.
+minor_tags = ["feat", "docs"]
 
 [tool.setuptools_scm]
 # The root for the gith repo is one directory up.

backend/tox.ini

@@ -55,7 +55,7 @@ allowlist_externals =
 deps =
     -r{toxinidir}/requirements/doc.txt
 commands =
-    doc8 --ignore-path docs/_build README.rst docs
+    doc8 --ignore-path docs/_build docs
     rm -f docs/sample_plugin.rst
     rm -f docs/modules.rst
     make -e -C docs clean