-
Notifications
You must be signed in to change notification settings - Fork 688
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
Removed duplicate installation instructions from API Docs #4927
base: develop
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hello there first time contributor! Welcome to the MDAnalysis community! We ask that all contributors abide by our Code of Conduct and that first time contributors introduce themselves on GitHub Discussions so we can get to know you. You can learn more about participating here. Please also add yourself to package/AUTHORS
as part of this PR.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #4927 +/- ##
===========================================
- Coverage 93.66% 93.65% -0.01%
===========================================
Files 177 189 +12
Lines 21850 22911 +1061
Branches 3079 3077 -2
===========================================
+ Hits 20466 21458 +992
- Misses 933 1003 +70
+ Partials 451 450 -1 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If I'm not mistaken, this is your first contribution in this repo. Please add yourself to package/AUTHORS
.
Hi @orbeckst, thanks for your comment! I have addressed it and made some additional refinements to the page. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you please check that you don't need to backtick-quote rst anchors with spaces or special characters?
@@ -185,7 +114,7 @@ Thank you! | |||
.. toctree:: | |||
:maxdepth: 4 | |||
:caption: Documentation | |||
:numbered: | |||
:numbered: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
extra space, delete
package/doc/sphinx/source/index.rst
Outdated
**Source code** is available from | ||
https://github.com/MDAnalysis/mdanalysis/ and is packaged under the | ||
`Lesser GNU Public Licence, version 3 or any later version`_. Individual components | ||
The MDAnalysis source code is available on [GitHub](https://github.com/MDAnalysis/mdanalysis/) and is |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this link is the only one not rendering correctly in markdown
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @micaela-matta , I fixed it now.
Fixes #4929
Changes made in this Pull Request:
PR Checklist
package/CHANGELOG
file updated?package/AUTHORS
? (If it is not, add it!)Developers Certificate of Origin
I certify that I can submit this code contribution as described in the Developer Certificate of Origin, under the MDAnalysis LICENSE.
📚 Documentation preview 📚: https://mdanalysis--4927.org.readthedocs.build/en/4927/