Skip to content

Commit 4e788f7

Browse files
authored
Merge pull request #4374 from tybug/next
Clean up docs
2 parents d2e6826 + 814ead9 commit 4e788f7

File tree

7 files changed

+193
-239
lines changed

7 files changed

+193
-239
lines changed

hypothesis-python/docs/compatibility.rst

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -142,12 +142,3 @@ We ship type hints with Hypothesis itself. Though we always try to minimize brea
142142
We may also find more precise ways to describe the type of various interfaces, or change their type and runtime behaviour together in a way which is otherwise backwards-compatible.
143143

144144
There are known issues with inferring the type of examples generated by |st.deferred|, |st.recursive|, |st.one_of|, |st.dictionaries|, and |st.fixed_dictionaries|. We're following proposed updates to Python's typing standards, but unfortunately the long-standing interfaces of these strategies cannot (yet) be statically typechecked.
145-
146-
------------------------
147-
Regularly verifying this
148-
------------------------
149-
150-
Everything mentioned above as explicitly supported is checked on every commit
151-
with :gh-link:`GitHub Actions <actions>`.
152-
Our continuous delivery pipeline runs all of these checks before publishing
153-
each release, so when we say they're supported we really mean it.

hypothesis-python/docs/conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,13 +56,14 @@
5656
"numpy": "reference/strategies.html#numpy",
5757
"observability": "reference/integrations.html#observability",
5858
"settings": "reference/api.html#settings",
59+
"endorsements": "usage.html#testimonials",
5960
# TODO enable when we actually rename them
6061
# "extras": "extensions.html",
6162
"supported": "compatibility.html",
6263
"changes": "changelog.html",
6364
"strategies": "extensions.html",
6465
# these pages were removed without replacement
65-
# "support": "index.html",
66+
"support": "index.html",
6667
"manifesto": "index.html",
6768
"examples": "index.html",
6869
}

hypothesis-python/docs/endorsements.rst

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

hypothesis-python/docs/extensions.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
=============================
2-
Projects extending Hypothesis
3-
=============================
1+
======================
2+
Third-party extensions
3+
======================
44

55
There are a number of open-source community libraries that extend Hypothesis. This page lists some of them; you can find more by searching PyPI `by keyword <https://pypi.org/search/?q=hypothesis>`_ or `by framework classifier <https://pypi.org/search/?c=Framework+%3A%3A+Hypothesis>`_.
66

hypothesis-python/docs/index.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,6 @@ Technical API reference.
9595
.. toctree::
9696
:maxdepth: 1
9797
:hidden:
98-
:caption: Hypothesis
9998

10099
quickstart
101100
tutorial/index
@@ -104,17 +103,16 @@ Technical API reference.
104103
reference/index
105104
stateful
106105
Extras <extras>
107-
compatibility
108106
changelog
109107

110108
.. toctree::
111109
:maxdepth: 1
112110
:hidden:
113-
:caption: Community
111+
:caption: About Hypothesis
114112

115113
development
114+
compatibility
116115
usage
117116
extensions
118117
packaging
119118
community
120-
endorsements

hypothesis-python/docs/redirect.html.template

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
"details.html#hypothesis.target": "reference/api.html#hypothesis.target",
2323
"details.html#hypothesis.register_random": "reference/strategies.html#hypothesis.register_random",
2424
"details.html#hypothesis.strategies.SearchStrategy": "reference/strategies.html#hypothesis.strategies.SearchStrategy",
25+
"details.html#test-statistics": "reference/integrations.html#statistics",
2526
};
2627
var redirect = manualRedirects[window.location.pathname.split('/').pop() + window.location.hash];
2728

0 commit comments

Comments
 (0)