Mike Auty
f95be04305
Documentation: Bump the copyright here to 2024
2024-01-31 21:36:21 +00:00
Mike Auty
da203f7d68
Documentation: Improve library documentation
...
Fixes #993 .
2023-09-03 22:07:20 +01:00
Mike Auty
a9698e4e73
Documentation: minor fixes/updates
2023-07-01 17:01:33 +01:00
Mike Auty
129b92e3ee
Core: Fix code scanning warnings/notes
2022-11-13 14:48:33 +00:00
Tejas and Abhinandhan S
0f6bb99d11
Cross document linked for symbol table
...
Received help from my friend to resolve issues with it
Co-authored-by: Abhinandhan S <abhi.varadan@gmail.com >
Signed-off-by: Tejas <47889755+tejas15802@users.noreply.github.com >
2022-03-29 17:41:37 +05:30
Nick L. Petroni, Jr
fa2a608cd2
update doc copyright
2022-01-16 17:32:02 -05:00
Mike Auty
57c9470f66
Documentation: Fix building from different directories
2022-01-16 22:09:15 +00:00
Mike Auty
8791631db5
Documentation: More minor fixes
2022-01-15 21:40:25 +00:00
Mike Auty
79e2a1494b
Documentation: Minor rename fixes.
2021-01-20 21:46:20 +00:00
Mike Auty
3911098d27
Core: Rename the top level namespace
2021-01-20 21:21:16 +00:00
Mike Auty
f262821924
Documentation: minor bugfix
2020-12-21 17:07:51 +00:00
Mike Auty
3b700bbee5
Documentation: Ensure non-os plugins are documented
2020-12-06 23:55:26 +00:00
Mike Auty
054a3618b8
Documentation: Fix missing construct_plugin
2020-10-28 22:59:13 +00:00
Mike Auty
ea20ae1c0c
Docs: Add CLI manpage (and fix a CLI option)
2020-06-28 00:57:46 +01:00
Nick L. Petroni, Jr and ikelos
cf08fef6ad
enable readthedocs support
2019-10-14 22:07:28 +01:00
Mike Auty
d7b1855099
Ensure the documentation versioning is consistent too.
2019-10-13 11:20:53 +01:00
Mike Auty
10a379b0ee
Make 'import as' consistent and ensure proper plugin dependencies.
2019-10-02 01:25:03 +01:00
Mike Auty
e0b9d72c84
Update the license URL and LICENSE.txt
2019-09-25 21:44:05 +01:00
Mike Auty
1153e86f23
Ensure user plugins are in the plugins documentation.
2019-09-19 22:59:28 +01:00
Mike Auty
aae1623696
Ensure we only remove autodoc files on clean command.
2019-09-19 22:42:06 +01:00
Mike Auty
3bb2e50f2c
Ensure the autodoc generated files are regenerated each run.
2019-09-17 18:33:58 +01:00
Mike Auty
9cde94bceb
Change the license blurb on all files.
2019-08-27 23:11:00 +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
fcd77b4c5f
Update the documentation to support the wrapper with autodoc-typehints.
2019-01-21 22:10:18 +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
b1d46f843b
Convert documentation to napoleon/Google format docstrings.
2018-08-05 15:52:12 +01: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
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
50e8f6a627
Add in PyCharm IDE project details, and improve the sphinx apidoc autogeneration of documentation.
2014-04-02 02:44:55 +01:00