Skip to content
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.

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

Update docs reqs #238

Merged
merged 2 commits into from
Dec 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ jobs:
# - Windows
# - MacOs
python-version:
- "3.14.0-alpha.0"
- "3.14.0-alpha.3"
- "3.13"
- "3.12"
- "3.11"
Expand Down
15 changes: 15 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
Contributor guidelines
======================

.. _fake.py: https://fakepy.readthedocs.io
.. _documentation: https://fakepy.readthedocs.io/#writing-documentation
.. _testing: https://fakepy.readthedocs.io/#testing
.. _pre-commit: https://pre-commit.com/#installation
Expand All @@ -20,6 +21,7 @@ Contributor guidelines
.. _recipes: https://fakepy.readthedocs.io/en/latest/recipes.html
.. _quick start: https://fakepy.readthedocs.io/en/latest/quick_start.html
.. _prerequisites: https://fakepy.readthedocs.io/#prerequisites
.. _versions manifest: https://github.com/actions/python-versions/blob/main/versions-manifest.json

Developer prerequisites
-----------------------
Expand Down Expand Up @@ -137,6 +139,19 @@ For example:
- Make sure to update the documentation (check whether the `installation`_,
`features`_, `recipes`_ and `quick start`_ require changes).

GitHub Actions
--------------
Only non-EOL versions of Python and software `fake.py`_ aims to integrate with
are supported.

On GitHub Actions includes tests for more than 40 different variations of
Python versions and integration packages. Future, non-stable versions
of Python are being tested too, so that new features/incompatibilities
could be seen and adopted early.

For the list of Python versions supported by GitHub, see GitHub Actions
`versions manifest`_.

Questions
---------
Questions can be asked on GitHub `discussions`_.
Expand Down
59 changes: 19 additions & 40 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,18 @@
# uv pip compile --all-extras -o docs/requirements.txt pyproject.toml
alabaster==0.7.16
# via sphinx
anyio==4.6.2.post1
anyio==4.7.0
# via
# starlette
# watchfiles
asgiref==3.8.1
# via django
asttokens==2.4.1
asttokens==3.0.0
# via stack-data
babel==2.16.0
# via sphinx
backports-tarfile==1.2.0
# via jaraco-context
certifi==2024.8.30
certifi==2024.12.14
# via requests
cffi==1.17.1
# via cryptography
charset-normalizer==3.4.0
# via requests
click==8.1.7
Expand All @@ -26,15 +22,13 @@ click==8.1.7
# uvicorn
colorama==0.4.6
# via sphinx-autobuild
coverage==7.6.8
coverage==7.6.9
# via pytest-cov
cryptography==43.0.3
# via secretstorage
decorator==5.1.1
# via ipython
detect-secrets==1.5.0
# via fake-py (pyproject.toml)
django==5.1.3
django==5.1.4
# via fake-py (pyproject.toml)
doc8==1.1.2
# via fake-py (pyproject.toml)
Expand All @@ -58,13 +52,9 @@ idna==3.10
# requests
imagesize==1.4.1
# via sphinx
importlib-metadata==8.5.0
# via
# keyring
# twine
iniconfig==2.0.0
# via pytest
ipython==8.29.0
ipython==8.30.0
# via fake-py (pyproject.toml)
jaraco-classes==3.4.0
# via keyring
Expand All @@ -74,10 +64,6 @@ jaraco-functools==4.1.0
# via keyring
jedi==0.19.2
# via ipython
jeepney==0.8.0
# via
# keyring
# secretstorage
jinja2==3.1.4
# via sphinx
keyring==25.5.0
Expand All @@ -98,19 +84,20 @@ mypy==1.13.0
# via fake-py (pyproject.toml)
mypy-extensions==1.0.0
# via mypy
nh3==0.2.18
nh3==0.2.20
# via readme-renderer
packaging==24.2
# via
# pytest
# sphinx
# twine
parso==0.8.4
# via jedi
pbr==6.1.0
# via stevedore
pexpect==4.9.0
# via ipython
pkginfo==1.10.0
pkginfo==1.12.0
# via twine
pluggy==1.5.0
# via pytest
Expand All @@ -120,9 +107,7 @@ ptyprocess==0.7.0
# via pexpect
pure-eval==0.2.3
# via stack-data
pycparser==2.22
# via cffi
pydoclint==0.5.9
pydoclint==0.5.12
# via fake-py (pyproject.toml)
pygments==2.18.0
# via
Expand All @@ -131,7 +116,7 @@ pygments==2.18.0
# readme-renderer
# rich
# sphinx
pytest==8.3.3
pytest==8.3.4
# via
# fake-py (pyproject.toml)
# pytest-cov
Expand Down Expand Up @@ -160,12 +145,8 @@ rfc3986==2.0.0
# via twine
rich==13.9.4
# via twine
ruff==0.8.0
ruff==0.8.3
# via fake-py (pyproject.toml)
secretstorage==3.3.3
# via keyring
six==1.16.0
# via asttokens
sniffio==1.3.1
# via anyio
snowballstemmer==2.2.0
Expand Down Expand Up @@ -197,37 +178,35 @@ sphinxcontrib-qthelp==2.0.0
# via sphinx
sphinxcontrib-serializinghtml==2.0.0
# via sphinx
sqlparse==0.5.2
sqlparse==0.5.3
# via django
stack-data==0.6.3
# via ipython
starlette==0.41.3
starlette==0.42.0
# via sphinx-autobuild
stevedore==5.4.0
# via doc8
traitlets==5.14.3
# via
# ipython
# matplotlib-inline
twine==5.1.1
twine==6.0.1
# via fake-py (pyproject.toml)
typing-extensions==4.12.2
# via
# ipython
# anyio
# mypy
urllib3==2.2.3
# via
# requests
# twine
uv==0.5.4
uv==0.5.10
# via fake-py (pyproject.toml)
uvicorn==0.32.1
uvicorn==0.34.0
# via sphinx-autobuild
watchfiles==0.24.0
watchfiles==1.0.3
# via sphinx-autobuild
wcwidth==0.2.13
# via prompt-toolkit
websockets==14.1
# via sphinx-autobuild
zipp==3.21.0
# via importlib-metadata
Loading