Updates Sphinx to 7+, use myst-parser instead of m2r2.

HugoFara · Jun 30, 2024 · 7bf185d · 7bf185d
1 parent 5fde45d
commit 7bf185d
Show file tree

Hide file tree

Showing 10 changed files with 23 additions and 11 deletions.
diff --git a/.idea/misc.xml b/.idea/misc.xml
diff --git a/.idea/pylinkage.iml b/.idea/pylinkage.iml
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -18,7 +18,7 @@ You will need to have your own fork for this project if you want to submit pull
 
 We use unittest. You can use it in two ways:
 
-* Just run ``python3 -m unittest discover .`` from the main folder.
+* Just run ``python -m unittest discover`` from the main folder.
 * For users of PyCharm, use the "All Tests" configuration.
 
 ## Release

diff --git a/pylinkage/geometry.py b/pylinkage/geometry.py
@@ -95,12 +95,14 @@ def circle_intersect(circle1, circle2, tol=0.0):
     :type circle2: tuple[float, float, float]
     :param tol: distance under which two points are considered equal (Default value = 0.0)
     :type tol: float
-    :returns: the intersections of two circles.
-    Can be:
+
+    :returns: the intersections of two circles. Can be:
+
         - (0, ) when no intersection.
         - (1, (float, float)) if the intersection is one point.
         - (2, (float, float), (float, float)) for two points of intersection.
         - (3, (float, float, float)) if the intersection is a circle.
+
     :rtype: tuple[int] | tuple[int, tuple[float, float]] |
     tuple[int, tuple[float, float], tuple[float, float]] | tuple[int, tuple[float, float, float]]
 

diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -2,7 +2,7 @@
 
 -r requirements.txt
 
-sphinx==6.2.1
+sphinx==7.3.7
 sphinx-rtd-theme>=1.2.0
-m2r2>=0.3.0
+myst-parser>=3.0.1
 bump2version>=1.0.0
diff --git a/sphinx/changeloglink.rst b/sphinx/changeloglink.rst
@@ -1 +1,2 @@
-.. mdinclude:: ../CHANGELOG.md
+.. include:: ../CHANGELOG.md
+   :parser: myst_parser.sphinx_
diff --git a/sphinx/code_of_conductlink.rst b/sphinx/code_of_conductlink.rst
@@ -0,0 +1,2 @@
+.. include:: ../CODE_OF_CONDUCT.md
+   :parser: myst_parser.sphinx_
diff --git a/sphinx/conf.py b/sphinx/conf.py
@@ -34,7 +34,7 @@
     # Use docstrings
     'sphinx.ext.autodoc',
     # Useful for markdown integration
-    'm2r2',
+    'myst_parser',
     'sphinx.ext.githubpages'
 ]
 

diff --git a/sphinx/index.rst b/sphinx/index.rst
@@ -31,6 +31,7 @@ Welcome to pylinkage's documentation!
    Source Code <https://github.com/HugoFara/pylinkage>
    Download on PyPi <https://pypi.org/project/pylinkage/>
    Get Support <https://github.com/HugoFara/pylinkage/issues>
+   Code of Conduct <code_of_conductlink.rst>
 
 .. include:: readmelink.rst
 

diff --git a/sphinx/readmelink.rst b/sphinx/readmelink.rst
@@ -1 +1,2 @@
-.. mdinclude:: ../README.md
+.. include:: ../README.md
+   :parser: myst_parser.sphinx_
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		.. include:: ../CODE_OF_CONDUCT.md
		:parser: myst_parser.sphinx_