-
Notifications
You must be signed in to change notification settings - Fork 673
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
Docs for WaterBridgeAnalysis incorrectly formatted/do not show up #3259
Comments
I think I might need some help with regard to this issue. Previously, the title is
However, I got PEP warning and I blindly change it to
which seems to give this problem. I wonder if there is any way of splitting the title into two lines? Thanks. |
Ignore the PEP8 warning. Check the docs when they are built. They appear on RTD and I think they get linked in the test report. |
I don't know of a way to split the line – maybe the sphinx or reST docs have something. Or maybe @lilyminium knows of a trick? |
I'm adding this as a 2.0 milestone, I guess if it's just a single line change it can just be done in #3120 ? |
This will get fixed as part of PR #3258 |
- fix MDAnalysis#3259 (title of Water Bridge Analysis docs is not correct) - include the Gregoret 1991 reference (that was removed with the deprecated hbonds.hbond_analysis module) - minor formatting fixes in the docs
- fix MDAnalysis#3259 (title of Water Bridge Analysis docs is not correct) - include the Gregoret 1991 reference (that was removed with the deprecated hbonds.hbond_analysis module) - minor formatting fixes in the docs
Fixes #2739 #3259 ## Work done in this PR * Moves hbond_autocorrel from hbonds to hydrogenbonds, stub will be removed in 3.0.0. * Removes deprecated hbonds.hbond_analysis code. * tests (note: tests were copied and we run full tests on the deprecated and the moved code, mainly to make sure that they can be called as expected; deprecation warnings are also tested) * make hydrogenbonds.hbond_autocorrel primary entry for docs * add entry for deprecated module at bottom of Hydrogen bonding docs * fixed doc in hydrogenbonds.wbridge_analysis * include the Gregoret 1991 reference (that was removed with the deprecated hbonds.hbond_analysis module) Co-authored-by: Oliver Beckstein <orbeckst@gmail.com>
Expected behavior
WaterBridgeAnalysis https://docs.mdanalysis.org/2.0.0-dev0/documentation_pages/analysis/wbridge_analysis.html shows up as its own entry.
Actual behavior
Instead it shows up under https://docs.mdanalysis.org/2.0.0-dev0/documentation_pages/analysis_modules.html#hydrogen-bonding
Code to reproduce the behavior
See links above.
This looks like an issue with the title formatting.
Current version of MDAnalysis
python -c "import MDAnalysis as mda; print(mda.__version__)"
) 2.0.0-dev docsThe text was updated successfully, but these errors were encountered: