Skip to content

Commit 443409e

Browse files
authored
Merge pull request mitmproxy#2890 from mitmproxy/newdocs
All new documentation
2 parents 1cacefa + 982508d commit 443409e

File tree

181 files changed

+12808
-3981
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

181 files changed

+12808
-3981
lines changed

.travis.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,6 @@ matrix:
2929
env: TOXENV=py36
3030
- python: 3.6
3131
env: TOXENV=individual_coverage
32-
- python: 3.6
33-
env: TOXENV=docs
3432
- language: node_js
3533
node_js: "node"
3634
before_install:

README.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -110,19 +110,18 @@ suite. The project tries to maintain 100% test coverage and enforces this strict
110110
Documentation
111111
-------------
112112

113-
The mitmproxy documentation is build using Sphinx_, which is installed
114-
automatically if you set up a development environment as described above. After
115-
installation, you can render the documentation like this:
113+
The following tools are required to build the mitmproxy docs:
114+
115+
- Hugo_
116+
- modd_
117+
- yarn_
116118

117119
.. code-block:: bash
118120
119121
cd docs
120-
make clean
121-
make html
122-
make livehtml
122+
yarn
123+
modd
123124
124-
The last command invokes `sphinx-autobuild`_, which watches the Sphinx directory and rebuilds
125-
the documentation when a change is detected.
126125
127126
Code Style
128127
----------
@@ -181,8 +180,9 @@ with the following command:
181180
.. _virtualenv: https://virtualenv.pypa.io/
182181
.. _`pytest`: http://pytest.org/
183182
.. _tox: https://tox.readthedocs.io/
184-
.. _Sphinx: http://sphinx-doc.org/
185-
.. _sphinx-autobuild: https://pypi.python.org/pypi/sphinx-autobuild
183+
.. _Hugo: https://gohugo.io/
184+
.. _modd: https://github.com/cortesi/modd
185+
.. _yarn: https://yarnpkg.com/en/
186186
.. _PEP8: https://www.python.org/dev/peps/pep-0008
187187
.. _`Google Style Guide`: https://google.github.io/styleguide/pyguide.html
188188
.. _forums: https://discourse.mitmproxy.org/

docs/.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
_build/
1+
src/public
2+
node_modules
3+
public

docs/Makefile

Lines changed: 0 additions & 195 deletions
This file was deleted.

docs/_static/theme_overrides.css

Lines changed: 0 additions & 44 deletions
This file was deleted.

docs/_templates/page.html

Lines changed: 0 additions & 10 deletions
This file was deleted.

0 commit comments

Comments
 (0)