enable readthedocs support

This commit is contained in:
Nick L. Petroni, Jr
2019-10-14 22:07:28 +01:00
committed by ikelos
parent 97e41e21e4
commit cf08fef6ad
2 changed files with 24 additions and 1 deletions
+22
View File
@@ -0,0 +1,22 @@
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: doc/source/conf.py
# Optionally build your docs in additional formats such as PDF and ePub
formats: all
# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.7
install:
- method: pip
path: .
extra_requirements:
- doc
+2 -1
View File
@@ -23,7 +23,8 @@ import sphinx.ext.apidoc
def setup(app):
volatility_directory = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..', 'volatility'))
sphinx.ext.apidoc.main(argv = ['-e', '-M', '-f', '-T', '-o', 'source', volatility_directory])
source_dir = os.path.abspath(os.path.dirname(__file__))
sphinx.ext.apidoc.main(argv = ['-e', '-M', '-f', '-T', '-o', source_dir, volatility_directory])
# Go through the volatility.framework.plugins files and change them to volatility.plugins
for dir, _, files in os.walk(os.path.dirname(__file__)):