Merge pull request #134 from gnikit/feature/sitemap

Feature/sitemap

Author: gnikit

.gitignore

@@ -15,3 +15,4 @@ fortls/_version.py
 *.log
 
 .coverage
+coverage.xml

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## Unreleased
 
+## 2.8.0
+
+### Added
+
+- Added `sitemap.xml` to documentation webpage
+  ([#134](https://github.com/gnikit/fortls/pull/134))
+
 ## 2.7.0
 
 ### Added

docs/conf.py

@@ -80,6 +80,7 @@
     "sphinx_design",
     "sphinx_copybutton",
     "myst_parser",
+    "sphinx_sitemap",
 ]
 # For sphinx_design in Markdown
 myst_enable_extensions = ["colon_fence"]
@@ -106,12 +107,17 @@
 html_title = "fortls"
 html_logo = "../assets/logo.svg"
 html_favicon = "../assets/icon.svg"
+html_baseurl = "https://gnikit.github.io/fortls/"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
 
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+html_extra_path = ["html_extra"]
 
 display_toc = True
 # autodoc_default_flags = ["members"]

docs/html_extra/robots.txt

@@ -0,0 +1,3 @@
+User-agent: *
+Disallow:
+Sitemap: https://gnikit.github.io/fortls/sitemap.xml

setup.cfg

@@ -66,6 +66,7 @@ docs =
     sphinx-copybutton
     furo
     myst-parser
+    sphinx-sitemap
 
 [flake8]
 max-line-length = 88