Skip to content

Commit

Permalink
All new documentation
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
cortesi committed Feb 22, 2018
1 parent 1cacefa commit 982508d
Show file tree
Hide file tree
Showing 181 changed files with 12,808 additions and 3,981 deletions.
2 changes: 0 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,6 @@ matrix:
env: TOXENV=py36
- python: 3.6
env: TOXENV=individual_coverage
- python: 3.6
env: TOXENV=docs
- language: node_js
node_js: "node"
before_install:
Expand Down
20 changes: 10 additions & 10 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,19 +110,18 @@ suite. The project tries to maintain 100% test coverage and enforces this strict
Documentation
-------------

The mitmproxy documentation is build using Sphinx_, which is installed
automatically if you set up a development environment as described above. After
installation, you can render the documentation like this:
The following tools are required to build the mitmproxy docs:

- Hugo_
- modd_
- yarn_

.. code-block:: bash
cd docs
make clean
make html
make livehtml
yarn
modd
The last command invokes `sphinx-autobuild`_, which watches the Sphinx directory and rebuilds
the documentation when a change is detected.
Code Style
----------
Expand Down Expand Up @@ -181,8 +180,9 @@ with the following command:
.. _virtualenv: https://virtualenv.pypa.io/
.. _`pytest`: http://pytest.org/
.. _tox: https://tox.readthedocs.io/
.. _Sphinx: http://sphinx-doc.org/
.. _sphinx-autobuild: https://pypi.python.org/pypi/sphinx-autobuild
.. _Hugo: https://gohugo.io/
.. _modd: https://github.com/cortesi/modd
.. _yarn: https://yarnpkg.com/en/
.. _PEP8: https://www.python.org/dev/peps/pep-0008
.. _`Google Style Guide`: https://google.github.io/styleguide/pyguide.html
.. _forums: https://discourse.mitmproxy.org/
Expand Down
4 changes: 3 additions & 1 deletion docs/.gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
_build/
src/public
node_modules
public
195 changes: 0 additions & 195 deletions docs/Makefile

This file was deleted.

44 changes: 0 additions & 44 deletions docs/_static/theme_overrides.css

This file was deleted.

10 changes: 0 additions & 10 deletions docs/_templates/page.html

This file was deleted.

Loading

0 comments on commit 982508d

Please sign in to comment.