Merge pull request #230 from calebstewart/docs-updates

Update Documentation Theme
calebstewart · Dec 31, 2021 · f18130e · f18130e
2 parents d621880 + 7257a48
commit f18130e
Show file tree

Hide file tree

Showing 6 changed files with 108 additions and 101 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -12,4 +12,5 @@ python:
  install:
  - method: pip
  path: .
- - requirements: docs/requirements.txt
+ extra_requirements:
+ - docs
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,6 +16,8 @@ and simply didn't have the time to go back and retroactively create one.
 - Added implant module `list` command to match documentation ([#224](https://github.com/calebstewart/pwncat/issues/224)).
 - Update documentation to clarify implant reconnection
 - Fixed `--ssl` argument parsing for bind channels.
+- Moved documentation theme to [furo](https://github.com/pradyunsg/furo).
+- Added Extras group for documentation depenedencies and removed `docs/requirements.txt`.
 
 ## [0.5.1] - 2021-12-07
 Minor bug fixes. Mainly typos from changing the package name.

diff --git a/docs/requirements.txt b/docs/requirements.txt
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -43,7 +43,7 @@
 # The theme to use for HTML and HTML Help pages. See the documentation for
 # a list of builtin themes.
 #
-html_theme = "sphinx_rtd_theme"
+html_theme = "furo"
 
 # 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,