Skip to content

Removed duplicate installation instructions from API Docs#4927

Merged
orbeckst merged 5 commits intoMDAnalysis:developfrom
namiroues:sdg23-cleanup-api-docs
Mar 14, 2025
Merged

Removed duplicate installation instructions from API Docs#4927
orbeckst merged 5 commits intoMDAnalysis:developfrom
namiroues:sdg23-cleanup-api-docs

Conversation

@namiroues
Copy link
Copy Markdown
Contributor

@namiroues namiroues commented Feb 23, 2025

Fixes #4929

Changes made in this Pull Request:

PR Checklist

  • Issue raised/referenced?
  • Tests updated/added?
  • Documentation updated/added?
  • package/CHANGELOG file updated?
  • Is your name in 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/

Copy link
Copy Markdown

@github-actions github-actions bot left a 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
Copy link
Copy Markdown

codecov bot commented Feb 23, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.42%. Comparing base (8fb40ad) to head (9034921).
Report is 22 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #4927   +/-   ##
========================================
  Coverage    93.42%   93.42%           
========================================
  Files          177      177           
  Lines        21859    21859           
  Branches      3078     3078           
========================================
  Hits         20422    20422           
  Misses         986      986           
  Partials       451      451           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Member

@RMeli RMeli left a 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.

@namiroues
Copy link
Copy Markdown
Contributor Author

Hi @orbeckst, thanks for your comment! I have addressed it and made some additional refinements to the page.
I would also like to kindly request @micaela-matta to review my changes. Thank you!

Copy link
Copy Markdown
Member

@orbeckst orbeckst left a 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?

:maxdepth: 4
:caption: Documentation
:numbered:
:numbered:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

extra space, delete

**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
Copy link
Copy Markdown
Contributor

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

Copy link
Copy Markdown
Contributor Author

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.

@orbeckst orbeckst enabled auto-merge (squash) March 13, 2025 00:03
@orbeckst
Copy link
Copy Markdown
Member

@micaela-matta can you have a quick look, please? Once you approve it will auto-merge.

@orbeckst orbeckst merged commit 9d072d9 into MDAnalysis:develop Mar 14, 2025
14 of 15 checks passed
orbeckst added a commit to MDAnalysis/UserGuide that referenced this pull request Mar 31, 2025
* Redesign installation guide in User Guide
* fixes #402
* fixes #405
* see also  MDAnalysis/mdanalysis#4927

---------
Co-authored-by: Oliver Beckstein <orbeckst@gmail.com>
Abdulrahman-PROG pushed a commit to Abdulrahman-PROG/mdanalysis that referenced this pull request Apr 13, 2025
…#4927)

* Fixes MDAnalysis#4929
* Removed duplicate installation instructions from API Docs
* related to MDAnalysis/UserGuide#404
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

Installation instructions cleanup in docs

5 participants