Merge pull request #685 from PlasmaControl/rc/doclink

Add docs links to github source
PlasmaControl · Sep 25, 2023 · a69a6cb · a69a6cb
2 parents 8332d11 + 449fb4f
commit a69a6cb
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 1 deletion.
diff --git a/devtools/dev-requirements.txt b/devtools/dev-requirements.txt
@@ -7,6 +7,8 @@ sphinx > 3.0.0
 sphinx-argparse
 sphinx_copybutton
 sphinx-rtd-theme >= 1.0, < 2.0
+sphinx-github-style >= 1.0, <= 1.1
+
 
 # linting
 black == 22.10.0

diff --git a/devtools/dev-requirements_conda.yml b/devtools/dev-requirements_conda.yml
@@ -27,6 +27,8 @@ dependencies:
   - sphinx-argparse
   - sphinx-copybutton
   - sphinx_rtd_theme >= 1.0, < 2.0
+  - pip:
+    - sphinx-github-style >= 1.0, <= 1.1
 
   # linting
   - black = 22.10.0

diff --git a/docs/conf.py b/docs/conf.py
@@ -42,14 +42,20 @@
     "sphinx.ext.coverage",
     "sphinx.ext.intersphinx",
     "sphinx.ext.mathjax",
-    "sphinx.ext.viewcode",
+    "sphinx_github_style",
     "sphinx.ext.githubpages",
     "nbsphinx",
     "sphinx.ext.napoleon",
     "sphinx.ext.autosummary",
     "sphinxarg.ext",
     "sphinx_copybutton",
 ]
+# options for sphinx_github_style
+top_level = "desc"
+linkcode_blob = "head"
+linkcode_url = r"https://github.com/PlasmaControl/DESC"
+linkcode_link_text = "Source"
+
 # numpydoc_class_members_toctree = False
 # Napoleon settings
 napoleon_google_docstring = False