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.

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

Jump to bottom

Better comments in spyrit/docs/source/conf.py > skip_member_handler() function #156

Closed
wants to merge 14 commits into from
Closed

Better comments in spyrit/docs/source/conf.py > skip_member_handler() function #156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
ef9bdea
commented skip_member_handler in conf.py
romainphan Feb 20, 2024
ac90ba5
Merge branch 'romain_dev' of https://github.com/openspyrit/spyrit int…
romainphan Feb 20, 2024
928ea3a
[pre-commit.ci] Automatic python formatting
pre-commit-ci[bot] Feb 20, 2024
1d6c013
proudly a new author on the docs website
romainphan Feb 21, 2024
eb6155d
[pre-commit.ci] Automatic python formatting
pre-commit-ci[bot] Feb 21, 2024
3ec0591
Added dynamic measurement operators / changed inheritance architecture
romainphan Feb 22, 2024
755f159
[pre-commit.ci] Automatic python formatting
pre-commit-ci[bot] Feb 22, 2024
d2de6e2
improved attributes management / docstring large update
romainphan Feb 23, 2024
bf91984
Merge branch 'romain_dev' of https://github.com/openspyrit/spyrit int…
romainphan Feb 23, 2024
37de02e
[pre-commit.ci] Automatic python formatting
pre-commit-ci[bot] Feb 23, 2024
415f24a
recon.py > reconstruct clarified documentation and called reconstruct…
romainphan Feb 23, 2024
422f300
tiny readability improvement
romainphan Feb 23, 2024
b0bd0ba
minor changes to walsh2_matrix
romainphan Feb 23, 2024
a8a8da7
Merge branch 'romain_dev' of https://github.com/openspyrit/spyrit int…
romainphan Feb 23, 2024
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
18 changes: 8 additions & 10 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,8 @@

# -- Project information -----------------------------------------------------
project = "spyrit"
copyright = "2021, Antonio Tomas Lorente Mur - Nicolas Ducros - Sebastien Crombez - Thomas Baudier"
author = (
"Antonio Tomas Lorente Mur - Nicolas Ducros - Sebastien Crombez - Thomas Baudier"
)
copyright = "2021, Antonio Tomas Lorente Mur - Nicolas Ducros - Sebastien Crombez - Thomas Baudier - Romain Phan"
author = "Antonio Tomas Lorente Mur - Nicolas Ducros - Sebastien Crombez - Thomas Baudier - Romain Phan"

# The full version, including alpha/beta/rc tags
release = "2.1.0"
Expand Down Expand Up @@ -116,16 +114,16 @@
# autodoc_mock_imports = "numpy matplotlib mpl_toolkits scipy torch torchvision Pillow opencv-python imutils PyWavelets pywt wget imageio".split()


# exclude all torch.nn.Module members from the documentation
# except forward and __init__ methods
# exclude all torch.nn.Module members (except forward method) from the docs:
import torch


def skip_member_handler(app, what, name, obj, skip, options):
if name in [
"forward",
]:
return False
always_document = [ # complete this list if needed by adding methods
"forward", # you *always* want to see documented
]
if name in always_document:
return None
if name in dir(torch.nn.Module):
return True
return None
Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,6 @@ When using SPyRiT specifically for the denoised completion network, please cite

Join the project
==================================
Feel free to contact us by `e-mail <mailto:nicolas.ducros@creatis.insa-lyon.fr>` for any question. Active developers are currently `Nicolas Ducros <https://www.creatis.insa-lyon.fr/~ducros/WebPage/index.html>`_, Thomas Baudier and `Juan Abascal <https://juanabascal78.wixsite.com/juan-abascal-webpage>`_. Direct contributions via pull requests (PRs) are welcome.
Feel free to contact us by `e-mail <mailto:nicolas.ducros@creatis.insa-lyon.fr>` for any question. Active developers are currently `Nicolas Ducros <https://www.creatis.insa-lyon.fr/~ducros/WebPage/index.html>`_, Thomas Baudier, `Juan Abascal <https://juanabascal78.wixsite.com/juan-abascal-webpage>`_ and Romain Phan. Direct contributions via pull requests (PRs) are welcome.

The full list of contributors can be found `here <https://github.com/openspyrit/spyrit/blob/master/README.md#contributors-alphabetical-order>`_.
Loading
Loading