Add changelog to readthedocs site

https://pulp.plan.io/issues/7033
closes #7033

CHANGES/7033.doc

@@ -0,0 +1 @@
+Adding changelog to readthedocs site

CHANGES.rst → docs/CHANGES.md

@@ -1,17 +1,16 @@
-=========
 Changelog
 =========
 
-..
+<!---
     You should *NOT* be adding new change log entries to this file, this
     file is managed by towncrier. You *may* edit previous change logs to
     fix problems like typo corrections or such.
     To add a new change log entry, please see
     https://docs.pulpproject.org/contributing/git.html#changelog-update
 
     WARNING: Don't drop the next directive!
-
-.. towncrier release notes start
+--->
+<!-- TOWNCRIER -->
 
 3.4.1 (2020-06-03)
 ==================
@@ -21,22 +20,22 @@ Bugfixes
 --------
 
 - Ensure that pip-tools is at least 5.2.0, so that the pre-flight (compatibility) check does not error on the attribute "editable".
-  `#6864 <https://pulp.plan.io/issues/6864>`_
+  [#6864](https://pulp.plan.io/issues/6864)
 
 
 Improved Documentation
 ----------------------
 
 - Document how to install from galaxy
-  `#6836 <https://pulp.plan.io/issues/6836>`_
+  [#6836](https://pulp.plan.io/issues/6836)
 - Replaced root README.md with a short README.md pointing users to the docs site
-  `#6843 <https://pulp.plan.io/issues/6843>`_
+  [#6843](https://pulp.plan.io/issues/6843)
 - Added a contributing guide, and moved testing out of the home page to it.
-  `#6862 <https://pulp.plan.io/issues/6862>`_
+  [#6862](https://pulp.plan.io/issues/6862)
 - Added a documentation section on Recommended Versioning Workflows
-  `#6874 <https://pulp.plan.io/issues/6874>`_
+  [#6874](https://pulp.plan.io/issues/6874)
 - Document how to file an issue
-  `#6879 <https://pulp.plan.io/issues/6879>`_
+  [#6879](https://pulp.plan.io/issues/6879)
 
 
 ----
@@ -50,37 +49,37 @@ Features
 --------
 
 - Make gunicorn --workers parameter configurable
-  `#6727 <https://pulp.plan.io/issues/6727>`_
+  [#6727](https://pulp.plan.io/issues/6727)
 
 
 Bugfixes
 --------
 
 - Enforce new lines when listing plugins on requirements.in
-  `#6697 <https://pulp.plan.io/issues/6697>`_
+  [#6697](https://pulp.plan.io/issues/6697)
 - Fixed CodeReady repo name for RHEL8 AWS installations
-  `#6805 <https://pulp.plan.io/issues/6805>`_
+  [#6805](https://pulp.plan.io/issues/6805)
 
 
 Improved Documentation
 ----------------------
 
 - Document the conflict between `version` and `upgrade` when configuring plugins
-  `#6669 <https://pulp.plan.io/issues/6669>`_
+  [#6669](https://pulp.plan.io/issues/6669)
 - Documented system requirements for ansible when using the installer.
-  `#6725 <https://pulp.plan.io/issues/6725>`_
+  [#6725](https://pulp.plan.io/issues/6725)
 
 
 Deprecations and Removals
 -------------------------
 
 - Fitting directories into collection structure
-  `#6458 <https://pulp.plan.io/issues/6458>`_
+  [#6458](https://pulp.plan.io/issues/6458)
 - Renaming roles to use underscores rather than dashes
-  `#6663 <https://pulp.plan.io/issues/6663>`_
+  [#6663](https://pulp.plan.io/issues/6663)
 - Replaced `pulp_workers` dictionary variable with the `pulp_workers` integer variable.
   `pulp_workers` is now simply the number of workers.
-  `#6774 <https://pulp.plan.io/issues/6774>`_
+  [#6774](https://pulp.plan.io/issues/6774)
 
 
 ----
@@ -94,46 +93,46 @@ Features
 --------
 
 - Introduced a CentOS version check
-  `#6102 <https://pulp.plan.io/issues/6102>`_
+  [#6102](https://pulp.plan.io/issues/6102)
 - Replaced nginx/apache alias with proxying to whitenoise
-  `#6561 <https://pulp.plan.io/issues/6561>`_
+  [#6561](https://pulp.plan.io/issues/6561)
 - Created a directory for Pulp nginx snippets
-  `#6594 <https://pulp.plan.io/issues/6594>`_
+  [#6594](https://pulp.plan.io/issues/6594)
 
 
 Bugfixes
 --------
 
 - Fixed: pulp_installer devel role failing on CentOS 8 Stream (pre-8.2) with a module metadata error for the dependency criu.
-  `#6509 <https://pulp.plan.io/issues/6509>`_
+  [#6509](https://pulp.plan.io/issues/6509)
 - Fixed several issues that cause the pre-flight check to not enforce (not terminating the install early on), which would lead to the instaler erroring at collectstatic, and leave users with a broken pulp installation.
-  `#6623 <https://pulp.plan.io/issues/6623>`_
+  [#6623](https://pulp.plan.io/issues/6623)
 - Fixed the pulpcore/plugin compatibility check not enforcing on upgrades from Pulp prior to 3.2.0, potentially resulting in a failure on collectstatic.
-  `#6642 <https://pulp.plan.io/issues/6642>`_
+  [#6642](https://pulp.plan.io/issues/6642)
 - Fixed the pulpcore/plugin compatibility check accidentally enforcing on upgrades when plugins have their upgrade variable specified, and the latest version of the plugin actually is compatible.
-  `#6643 <https://pulp.plan.io/issues/6643>`_
+  [#6643](https://pulp.plan.io/issues/6643)
 - Fixed the pulpcore/plugin compatibility check not enforcing on upgrades when some currently installed plugins are not specified by the user in pulp_install_plugins.
-  `#6644 <https://pulp.plan.io/issues/6644>`_
+  [#6644](https://pulp.plan.io/issues/6644)
 - Fixed the pulpcore/plugin compatibility check getting not enforcing when it needs the prereq roles applied to evaluate compatibility. It now runs before (and if necessary, after) the prereq roles.
-  `#6645 <https://pulp.plan.io/issues/6645>`_
+  [#6645](https://pulp.plan.io/issues/6645)
 - Fixed pre-flight check producing an error (and accidentally enforcing) when a package is installed system-wide at a version that is not available on PyPI. This issue was never present on the previous release, only on the develoment branch.
-  `#6689 <https://pulp.plan.io/issues/6689>`_
+  [#6689](https://pulp.plan.io/issues/6689)
 - Fixed pre-flight check producing an error (and accidentally enforcing) when trying & failing to build certain packages from PyPI that are actually available as a system-wide (RPM/deb-installed) package in the virtualenv. This issue was never present on the previous release, only on the develoment branch.
-  `#6690 <https://pulp.plan.io/issues/6690>`_
+  [#6690](https://pulp.plan.io/issues/6690)
 
 
 Deprecations and Removals
 -------------------------
 
 - Removed the pulp_webserver_static_dir option.
   This fixes a bug where installations served content they should not.
-  `#6601 <https://pulp.plan.io/issues/6601>`_
+  [#6601](https://pulp.plan.io/issues/6601)
 
 
 Misc
 ----
 
-- `#6508 <https://pulp.plan.io/issues/6508>`_, `#6535 <https://pulp.plan.io/issues/6535>`_, `#6587 <https://pulp.plan.io/issues/6587>`_, `#6602 <https://pulp.plan.io/issues/6602>`_, `#6666 <https://pulp.plan.io/issues/6666>`_
+- [#6508](https://pulp.plan.io/issues/6508), [#6535](https://pulp.plan.io/issues/6535), [#6587](https://pulp.plan.io/issues/6587), [#6602](https://pulp.plan.io/issues/6602), [#6666](https://pulp.plan.io/issues/6666)
 
 
 ----

mkdocs.yml

@@ -10,6 +10,7 @@ nav:
   - Home: index.md
   - Getting started: quickstart.md
   - contributing.md
+  - Changelog: CHANGES.md
   - Roles:
       - Pulp Common: roles/pulp_common.md
       - Pulp API: roles/pulp_api.md

pyproject.toml

@@ -1,7 +1,8 @@
 [tool.towncrier]
 package = "pulp_installer"
-filename = "CHANGES.rst"
+filename = "docs/CHANGES.md"
 directory = "CHANGES/"
 title_format = "{version} ({project_date})"
-template = "CHANGES/.TEMPLATE.rst"
-issue_format = "`#{issue} <https://pulp.plan.io/issues/{issue}>`_"
+template = "CHANGES/.TEMPLATE.md"
+issue_format = "[#{issue}](https://pulp.plan.io/issues/{issue})"
+start_string = "<!-- TOWNCRIER -->\n"