Commit Graph
36 Commits
Author SHA1 Message Date
Mike Auty a3caf39097 Use a mapping to determine kind to class. 2019-08-31 12:57:53 +01:00
Mike Auty 9cde94bceb Change the license blurb on all files. 2019-08-27 23:11:00 +01:00
Mike Auty 58dffe8795 Fix typos from the rebase, and add documentation. 2019-08-27 21:08:29 +01:00
Mike Auty 1039189f7e More proof reading of the documentation. 2019-08-24 01:10:34 +01:00
Mike Auty 0b6c991b10 Fix up issues in the simple-plugin example. 2019-08-23 21:35:52 +01:00
Mike Auty 4adfffb381 Proof read the basics documentation and add in additional sections to complex. 2019-08-23 12:26:19 +01:00
Mike Auty f8c91fa4da Add in more advanced documentation. 2019-08-20 00:13:16 +01:00
Mike Auty c0f650ba78 Ensure Mac plugins are documented and add complex tasks documentation. 2019-08-18 22:35:34 +01:00
Mike Auty ea7ca23987 Update the documentation generation and sphinx used. 2019-08-18 18:28:34 +01:00
Mike Auty cb57905585 Try out a different style of documentation and options. 2019-08-18 01:20:32 +01:00
Mike Auty 2e7460b683 Fix a typo and slightly reword. 2019-07-17 12:26:35 +01:00
Mike Auty 900bbbb44f Add in additional documentation. 2019-07-17 01:23:32 +01:00
Mike Auty 754b3f0bc6 Refactor create_filter to create_pid_filter. 2019-04-18 01:10:07 +01:00
Mike Auty 2aa07596c2 Fix up filtering in mac and remove the last of the filter shadowing. 2019-02-28 09:48:15 +00:00
Mike Auty 4e8c8a7232 Fix issues with SymbolRequirement refactoring. 2019-02-11 22:30:22 +00:00
Mike Auty fcd77b4c5f Update the documentation to support the wrapper with autodoc-typehints. 2019-01-21 22:10:18 +00:00
Mike Auty 040da46deb Fix up the descriptions for non-simple requirements. 2019-01-03 00:39:53 +00:00
Mike Auty fdc6efc4ad Add in the LICENSE and the README. 2018-12-19 23:55:03 +00:00
Mike Auty 19572b6e1e Reformat all python files using yapf with custom volatility style. 2018-12-16 16:50:17 +00:00
Mike Auty 44592c63ca Update dependencies to support sphinx_autodoc_typehints. 2018-11-13 12:01:57 +00:00
Mike Auty 3713e9484c Add in a setup.py and fix up the documentation so setuptools can build it. 2018-09-01 22:28:03 +01:00
Mike Auty 5791cfaab7 Stop overriding the builtin filter method, and ensure suitable parameter names. 2018-08-30 11:41:19 +01:00
Mike Auty 0f08432aa5 Refactor Symbol interface to SymbolInterface. 2018-08-09 14:28:08 +01:00
Mike Auty 60f31852b9 Add in basic documentation covering an example plugin. 2018-08-08 00:41:08 +01:00
Mike Auty d092a0614d Add in volatility 3 basics documentation. 2018-08-06 14:21:33 +01:00
Mike Auty b1d46f843b Convert documentation to napoleon/Google format docstrings. 2018-08-05 15:52:12 +01:00
Mike Auty b938f61228 Update the favicon with white backgrounding to improve visibility. 2016-12-30 02:12:36 +00:00
Mike Auty 87b259ab54 Make the documentation a little more like the official python docs, with a favicon and a small icon on the navigation bar. 2016-12-30 01:09:27 +00:00
Mike Auty 686e7c8812 Put modules first in the documentation, and avoid putting subheadings on the front page. 2016-12-29 00:50:41 +00:00
Mike Auty 3bdb4f4c99 Ensure that inherited members are documented (and that attributes come after methods for clarity. 2016-12-28 22:32:04 +00:00
Nick L. Petroni, Jr e173c7c080 Squashed commit of the following:
commit fbf5eb6309
Author: Mike Auty <mike.auty@gmail.com>
Date:   Sat Aug 20 13:21:47 2016 +0100

    Remove other unnecessary files and drop the templates, but use the static files.

commit 2bf92be628
Author: Mike Auty <mike.auty@gmail.com>
Date:   Sat Aug 20 13:10:20 2016 +0100

    Remove unnecessary elements imported with the python3 doc theme.

commit 31b6d84e58
Author: Mike Auty <mike.auty@gmail.com>
Date:   Sat Aug 20 12:07:08 2016 +0100

    Add in python3 documentation theme files and convert to using those.
2016-08-20 14:13:32 -04:00
Nick L. Petroni, Jr 84f64a2394 doc: auto-generate files and cleanup syntax 2016-08-18 17:01:09 -04:00
Mike Auty 6d7acb08f2 Minor pylinting on the docs. 2015-01-04 21:12:38 +00:00
Mike Auty 39c0b38f09 Add additional docstrings and refactor/rearrange the entire codebase. 2014-06-11 01:35:50 +01:00
Mike Auty 6b542d1782 Add in workspace.xml to gitignore, and the main modules.rst. 2014-04-05 19:43:31 +01:00
Mike Auty 50e8f6a627 Add in PyCharm IDE project details, and improve the sphinx apidoc autogeneration of documentation. 2014-04-02 02:44:55 +01:00