mitmproxy/docs/modd.conf

{
    daemon: cd src; hugo server -D
}

style/** {
    # This is quite fast, so it can stay a prep rather than a daemon
    prep:  ./node_modules/.bin/node-sass -o ./src/themes/mitmproxydocs/static/css ./style/style.scss --error-bell
}
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 04:21:34 +00:00			`{`
			`daemon: cd src; hugo server -D`
			`}`
Doc tweaks This patch does the following: - Fixes all warnings in the doc tree - Adds a modd + devd conf file that renders HTML and treats doc warnings as errors. This lets you send warning output to your desktop notifier, and gives livereload similar to the livehtml entry in the Makefile. - Some small tweaks Sphinx currently has a bug that causes unknown options to generate a warning: https://github.com/sphinx-doc/sphinx/issues/2229 This is fixed in stable, but not yet released. You can update Sphinx to the latest stable like so: pip install --upgrade https://github.com/sphinx-doc/sphinx/archive/stable.zip 2016-02-20 22:41:59 +00:00
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 04:21:34 +00:00			`style/** {`
			`# This is quite fast, so it can stay a prep rather than a daemon`
			`prep: ./node_modules/.bin/node-sass -o ./src/themes/mitmproxydocs/static/css ./style/style.scss --error-bell`
Doc tweaks This patch does the following: - Fixes all warnings in the doc tree - Adds a modd + devd conf file that renders HTML and treats doc warnings as errors. This lets you send warning output to your desktop notifier, and gives livereload similar to the livehtml entry in the Makefile. - Some small tweaks Sphinx currently has a bug that causes unknown options to generate a warning: https://github.com/sphinx-doc/sphinx/issues/2229 This is fixed in stable, but not yet released. You can update Sphinx to the latest stable like so: pip install --upgrade https://github.com/sphinx-doc/sphinx/archive/stable.zip 2016-02-20 22:41:59 +00:00			`}`