Commit Graph

13 Commits

Author SHA1 Message Date
Maximilian Hils 81f8f06a11 converge on hooks, events, and commands 2021-01-05 22:00:54 +01:00
Maximilian Hils 6c0e4f1cb7 streamline event/hook/command naming conventions 2021-01-05 21:54:44 +01:00
Maximilian Hils 90df4168f8 coverage++ 2021-01-05 21:54:44 +01:00
Maximilian Hils 667cacba3f generate event documentation from source 2021-01-05 21:54:44 +01:00
Martin Plattner ed918cca87 fix linting error 2020-09-04 18:51:02 +02:00
Martin Plattner 88d43b51bb tweak cli recordings 2020-09-04 18:45:54 +02:00
Martin Plattner d305c973f5 merge CliDirector and MitmCliDirector 2020-09-04 15:22:04 +02:00
Martin Plattner 129c03e51a integrate feedback 2020-09-04 15:02:58 +02:00
Martin Plattner b6d52fc8ab add cli recording scripts 2020-09-03 17:44:00 +02:00
Maximilian Hils 08895e9ba6 restructure examples
- restructure examples (fix #4031)
 - remove example dependencies from setup.py,
   we do not need special dependencies for our supported addons.
 - unify how we generate docs from code
 - improve example docs
2020-06-23 16:00:14 +02:00
Thomas Kriechbaumer f6699792da docs: add auto-generated options reference 2018-03-25 13:42:55 +02:00
Maximilian Hils 0e62e386c0 docs: add skeleton for options script 2018-03-24 23:14:58 +01:00
Aldo Cortesi 982508d30f All new documentation
This patch does a lot.

- Ditch sphinx in favor of hugo. This gives us complete control of the layout
and presentation of our docs. Henceforth, docs will be hosted on our website
rather than ReadTheDocs.
- Create a simple, clean doc layout and theme.
- Remove large parts of the documentaion. I've ditched anything that was a)
woefully out of date, b) too detailed, or c) too hard to maintain in the long
term.
- Huge updates to the docs themselves: completely rewrite addons documentation,
add docs for core concepts like commands and options, and revise and tweak a
lot of the existing docs.

With this patch, we're also changing the way we publish and maintain the docs.
From now on, we don't publish docs for every release. Instead, the website will
contain ONE set of docs for each major release. The online docs will be updated
if needed as minor releases are made. Docs are free to improve during minor
releases, but anything that changes behaviour sufficiently to require a doc
change warrants a new major release. This also leaves us free to progressively
update and improve docs out of step with our release cadence.

With this new scheme, I feel CI over the docs is less important. I've removed
it for now, but won't object if someone wants to add it back in.
2018-02-22 18:07:58 +13:00