Skip to content

Moved documentation topics to group them by theme. #8431

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nicoddemus merged 1 commit into from
Mar 11, 2021
Merged

Moved documentation topics to group them by theme. #8431

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/en/_templates/globaltoc.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ <h3><a href="{{ pathto(master_doc) }}">{{ _('Table Of Contents') }}</a></h3>
<ul>
<li><a href="{{ pathto('index') }}">Home</a></li>
<li><a href="{{ pathto('getting-started') }}">Get started</a></li>
<li><a href="{{ pathto('contents') }}">Contents</a></li>
<li><a href="{{ pathto('reference') }}">API Reference</a></li>
<li><a href="{{ pathto('example/index') }}">Examples</a></li>
<li><a href="{{ pathto('customize') }}">Customize</a></li>
<li><a href="{{ pathto('reference') }}">API Reference</a></li>
<li><a href="{{ pathto('plugin_list') }}">3rd party plugins</a></li>
<li><a href="{{ pathto('contents') }}">Complete table of contents</a></li>
<li><a href="{{ pathto('changelog') }}">Changelog</a></li>
<li><a href="{{ pathto('contributing') }}">Contributing</a></li>
<li><a href="{{ pathto('backwards-compatibility') }}">Backwards Compatibility</a></li>
Expand Down
41 changes: 34 additions & 7 deletions doc/en/contents.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,38 +7,65 @@ Full pytest documentation

.. `Download latest version as EPUB <http://media.readthedocs.org/epub/pytest/latest/pytest.epub>`_


Start here
-----------

.. toctree::
:maxdepth: 2

getting-started


How-to guides
-------------

.. toctree::
:maxdepth: 2

usage
existingtestsuite
assert
fixture
mark
monkeypatch
tmpdir
capture
warnings
doctest
skipping
parametrize
plugins
nose
bash-completion


Reference guides
-----------------

.. toctree::
:maxdepth: 2

fixture
Copy link
Member

@nicoddemus nicoddemus Mar 11, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps this should be part of the "How-to" guides, given how fundamental fixtures are?

Copy link
Contributor Author

@evildmp evildmp Mar 11, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nicoddemus I have big plans for fixture.rst; it's way too large and contains multiple different kinds of things, so I plan to split it up and redistribute its contents in the PR coming after next.

Copy link
Member

@nicoddemus nicoddemus Mar 11, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, sounds good!

warnings
doctest
cache
unittest
nose
xunit_setup
plugins
plugin_list
writing_plugins
logging
customize
reference


Further topics
-----------------

.. toctree::
:maxdepth: 2

goodpractices
flaky
pythonpath
customize
example/index
bash-completion

backwards-compatibility
deprecations
Expand Down