[DOCs][Added] Changelog to the RSTs

CHANGELOG.md

@@ -279,8 +279,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Support for time stamp in the date (i.e. 2023-04-02T09:22-03:00)
   - Support to pass variables to the 3D models download URL (#414)
   - Support for netclass flags (#418)
-  - Export KICADn_* environment variables for the older versions
-    So you can use KICAD6_* variables on KiCad 7.
+  - Export *KICADn_* environment variables for the older versions
+    So you can use *KICAD6_* variables on KiCad 7.
 - Expansion patterns:
   - **%M** directory where the pcb/sch resides. Only the last component
     i.e. /a/b/c/name.kicad_pcb -> c  (#421)
@@ -503,7 +503,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Gerber: Extension used for JLCPCB inner layers. (#329)
 - BoM:
   - The length of the CSV separator is now validated.
-  - Using \t, \n, \r and \\ is now supported. (See #334)
+  - Using the escaped t, n, r and \ is now supported. (See #334)
   - Digi-key link in the HTML output.
 - KiBoM: User defined fields wasn't available as column names. (#344)
 - Imports:

docs/Makefile

@@ -50,6 +50,11 @@ source/rotations.rst: ../kibot/misc.py ../kibot/config_reader.py
 source/offsets.rst: ../kibot/misc.py ../kibot/config_reader.py
 	../src/kibot --help-list-offsets > $@
 
+source/Changelog.rst: ../CHANGELOG.md
+	pandoc -o tmp.rst $<
+	cat changelog_pre.rst tmp.rst > $@
+	rm tmp.rst
+
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
@@ -57,7 +62,7 @@ help:
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 $(SPHINXTARGETS): Makefile source/configuration/sup_outputs.rst source/dependencies.rst source/usage.txt source/configuration/sup_preflights.rst \
 	source/configuration/sup_filters.rst source/configuration/sup_variants.rst source/configuration/sup_globals.rst source/errors.rst \
-	source/rotations.rst source/offsets.rst
+	source/rotations.rst source/offsets.rst source/Changelog.rst
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 

docs/changelog_pre.rst

@@ -0,0 +1,5 @@
+.. index::
+   single: Changelog
+
+.. _Changelog:
+

docs/source/conf.py

@@ -78,7 +78,7 @@ if branch == 'HEAD':
 
 if branch != "master":
     doc_id = ("**This is the documentation for the current development KiBot, not yet released. "
-              "To know what changed see the**  `changelog <CHANGELOG.md>`__")
+              "To know what changed see the**  :ref:`Changelog`")
 else:
     doc_id = (f"**This is the documentation for KiBot v{release} for the current development read** "
               "`here <https://github.com/INTI-CMNB/KiBot/tree/dev>`__")

docs/source/index.rst

@@ -39,6 +39,7 @@ KiBot (formerly KiPlot)
    notes_3d
    propose
    KiPlotYAML
+   Changelog
 
 .. toctree::
    :maxdepth: 2