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

docs: render module level docstrings in documentation #218

Merged

Saransh-cpp merged 2 commits into scikit-hep:main from Saransh-cpp:saransh/misplaced-docstrings

Jun 29, 2022

Member

Saransh-cpp commented Jun 29, 2022

This PR moves the module level docstrings above the imports which makes them render nicely in the sphinx docs.

Saransh-cpp added 2 commits

June 28, 2022 22:49


          docs: make docstrings render in sphinx

07afbbe


          Remove the 'Note' for API docs in index.rst

74d3f48

Saransh-cpp merged commit df29a8e into scikit-hep:main

Saransh-cpp deleted the saransh/misplaced-docstrings branch

June 29, 2022 09:53

Saransh-cpp added this to the v0.9.0 milestone

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet