Skip to content

Commit

Permalink
update sphinx options to re-enable autodocs (#369)
Browse files Browse the repository at this point in the history
* update sphinx options to re-enable autodocs

* <bot> update requirements-docs.txt

* <bot> update requirements-tests.txt

* <bot> update requirements.txt

* flexmock doesn't like pytest 8.1 yet

* <bot> update requirements-tests.txt

---------

Co-authored-by: github-actions <[email protected]>
  • Loading branch information
dsschult and github-actions authored Mar 14, 2024
1 parent d2d7e9b commit a7dd319
Show file tree
Hide file tree
Showing 8 changed files with 31 additions and 56 deletions.
5 changes: 4 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,10 @@ def nodecorate(func):

autodoc_member_order = 'bysource'
autoclass_content = 'both'
autodoc_default_flags = ['members', 'undoc-members']
autodoc_default_options = {
'members': True,
'undoc-members': True,
}

# Without this line sphinx includes a copy of object.__init__'s docstring
# on any class that doesn't define __init__.
Expand Down
2 changes: 1 addition & 1 deletion docs/server/auth.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@
Token Authentication
====================

.. automodule:: iceprod.server.auth
.. automodule:: iceprod.client_auth
24 changes: 0 additions & 24 deletions docs/server/dbmethods.rst

This file was deleted.

4 changes: 0 additions & 4 deletions docs/server/tornado.rst

This file was deleted.

16 changes: 8 additions & 8 deletions requirements-docs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ asyncache==0.3.1
# via iceprod (setup.py)
babel==2.14.0
# via sphinx
boto3==1.34.49
boto3==1.34.62
# via iceprod (setup.py)
botocore==1.34.49
botocore==1.34.62
# via
# boto3
# s3transfer
cachetools==5.3.2
cachetools==5.3.3
# via
# asyncache
# iceprod (setup.py)
Expand Down Expand Up @@ -69,7 +69,7 @@ markupsafe==2.1.5
# via jinja2
motor==3.3.2
# via iceprod (setup.py)
packaging==23.2
packaging==24.0
# via sphinx
psutil==5.9.8
# via iceprod (setup.py)
Expand All @@ -85,11 +85,11 @@ pymongo==4.6.2
# via
# iceprod (setup.py)
# motor
pyopenssl==24.0.0
pyopenssl==24.1.0
# via iceprod (setup.py)
pypng==0.20220715.0
# via qrcode
python-dateutil==2.8.2
python-dateutil==2.9.0.post0
# via
# botocore
# iceprod (setup.py)
Expand Down Expand Up @@ -117,7 +117,7 @@ setproctitle==1.3.3
# via iceprod (setup.py)
six==1.16.0
# via python-dateutil
sniffio==1.3.0
sniffio==1.3.1
# via
# anyio
# httpx
Expand All @@ -143,7 +143,7 @@ tornado==6.4
# via
# iceprod (setup.py)
# wipac-rest-tools
typing-extensions==4.9.0
typing-extensions==4.10.0
# via
# anyio
# qrcode
Expand Down
20 changes: 10 additions & 10 deletions requirements-tests.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ asyncache==0.3.1
# via iceprod (setup.py)
beautifulsoup4==4.12.3
# via iceprod (setup.py)
boto3==1.34.49
boto3==1.34.62
# via
# iceprod (setup.py)
# moto
botocore==1.34.49
botocore==1.34.62
# via
# boto3
# moto
# s3transfer
cachetools==5.3.2
cachetools==5.3.3
# via
# asyncache
# iceprod (setup.py)
Expand Down Expand Up @@ -85,11 +85,11 @@ mccabe==0.7.0
# via flake8
mock==5.1.0
# via iceprod (setup.py)
moto[s3]==5.0.2
moto[s3]==5.0.3
# via iceprod (setup.py)
motor==3.3.2
# via iceprod (setup.py)
packaging==23.2
packaging==24.0
# via pytest
pluggy==1.4.0
# via pytest
Expand All @@ -111,7 +111,7 @@ pymongo==4.6.2
# via
# iceprod (setup.py)
# motor
pyopenssl==24.0.0
pyopenssl==24.1.0
# via iceprod (setup.py)
pypng==0.20220715.0
# via qrcode
Expand All @@ -121,13 +121,13 @@ pytest==8.0.2
# pytest-asyncio
# pytest-cov
# pytest-mock
pytest-asyncio==0.23.5
pytest-asyncio==0.23.5.post1
# via iceprod (setup.py)
pytest-cov==4.1.0
# via iceprod (setup.py)
pytest-mock==3.12.0
# via iceprod (setup.py)
python-dateutil==2.8.2
python-dateutil==2.9.0.post0
# via
# botocore
# iceprod (setup.py)
Expand Down Expand Up @@ -169,7 +169,7 @@ six==1.16.0
# via
# python-dateutil
# requests-mock
sniffio==1.3.0
sniffio==1.3.1
# via
# anyio
# httpx
Expand All @@ -185,7 +185,7 @@ tornado==6.4
# via
# iceprod (setup.py)
# wipac-rest-tools
typing-extensions==4.9.0
typing-extensions==4.10.0
# via
# anyio
# qrcode
Expand Down
14 changes: 7 additions & 7 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ anyio==4.3.0
# via httpx
asyncache==0.3.1
# via iceprod (setup.py)
boto3==1.34.49
boto3==1.34.62
# via iceprod (setup.py)
botocore==1.34.49
botocore==1.34.62
# via
# boto3
# s3transfer
cachetools==5.3.2
cachetools==5.3.3
# via
# asyncache
# iceprod (setup.py)
Expand Down Expand Up @@ -69,11 +69,11 @@ pymongo==4.6.2
# via
# iceprod (setup.py)
# motor
pyopenssl==24.0.0
pyopenssl==24.1.0
# via iceprod (setup.py)
pypng==0.20220715.0
# via qrcode
python-dateutil==2.8.2
python-dateutil==2.9.0.post0
# via
# botocore
# iceprod (setup.py)
Expand All @@ -100,7 +100,7 @@ setproctitle==1.3.3
# via iceprod (setup.py)
six==1.16.0
# via python-dateutil
sniffio==1.3.0
sniffio==1.3.1
# via
# anyio
# httpx
Expand All @@ -110,7 +110,7 @@ tornado==6.4
# via
# iceprod (setup.py)
# wipac-rest-tools
typing-extensions==4.9.0
typing-extensions==4.10.0
# via
# anyio
# qrcode
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ tests =
flexmock
mock
moto[s3]>=5
pytest
pytest<8.1
pytest-asyncio
pytest-cov
pytest-mock
Expand Down

0 comments on commit a7dd319

Please sign in to comment.