Add sitemap (#902)

blackyblack · Sep 13, 2024 · 7a2eca9 · 7a2eca9
1 parent eae579f
commit 7a2eca9
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 3 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -38,6 +38,7 @@
     "sphinx.ext.autosectionlabel",
     "sphinx.ext.mathjax",
     "sphinx.ext.githubpages",
+    "sphinx_sitemap",
 ]
 
 # List of patterns, relative to source directory, that match files and
@@ -59,6 +60,8 @@
 
 html_extra_path = ["_extra/googlea3669135f4e8d2d0.html"]
 
+html_baseurl = "https://symplyphysics.github.io"
+
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
 add_module_names = False

diff --git a/docs/index.rst b/docs/index.rst
@@ -3,6 +3,8 @@ Symplyphysics
 
 Physics laws implemented as code. Based on `SymPy <https://github.com/sympy/sympy>`_ Python library.
 
+Autogenerated from `Symplyphysics <https://github.com/blackyblack/symplyphysics>`_ project.
+
 Contents:
 
 .. toctree::

diff --git a/pyproject.toml b/pyproject.toml
@@ -26,7 +26,8 @@ dev = [
   "pytest",
   "mypy",
   "pylint",
-  "Sphinx"
+  "Sphinx",
+  "sphinx-sitemap",
 ]
 
 [tool.setuptools.packages.find]

diff --git a/symplyphysics/laws/condensed_matter/effective_mass_of_electron_via_energy.py b/symplyphysics/laws/condensed_matter/effective_mass_of_electron_via_energy.py
@@ -1,4 +1,4 @@
-"""
+r"""
 Effective mass of electron via energy
 =====================================
 
@@ -30,7 +30,7 @@
     validate_output,
 )
 
-effective_mass = clone_symbol(symbols.basic.mass, display_symbol="m_eff", display_latex=r"m_\text{eff}")
+effective_mass = clone_symbol(symbols.basic.mass, display_symbol="m_eff", display_latex="m_\\text{eff}")
 r"""
 Effective :attr:`~symplyphysics.symbols.basic.mass` of the electron.
 """