diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 000000000..764bb5a1a --- /dev/null +++ b/.readthedocs.yml @@ -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 diff --git a/doc/source/conf.py b/doc/source/conf.py index ab5025a4e..86854ed70 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -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__)):