Fix Sphinx documentation build warnings#454
Closed
xiki-tempula wants to merge 3 commits intoalchemistry:masterfrom
Closed
Fix Sphinx documentation build warnings#454xiki-tempula wants to merge 3 commits intoalchemistry:masterfrom
xiki-tempula wants to merge 3 commits intoalchemistry:masterfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #454 +/- ##
=======================================
Coverage 99.01% 99.01%
=======================================
Files 29 29
Lines 2446 2447 +1
Branches 464 464
=======================================
+ Hits 2422 2423 +1
Misses 2 2
Partials 22 22 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Collaborator
Author
|
Annoying, this break the hyperlink. I guess if not broken, don't fix it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Changes
Duplicate object descriptions from
automodule+ explicit directives:Added
:no-members:toautomoduledirectives in files that also have explicitautofunction/autoclassdirectives below. Theautodoc_default_optionsinconf.pysets"members": Trueglobally, which causedautomoduleto auto-document all members — duplicating the explicit directives that follow.parsing/alchemlyb.parsing.{amber,gmx,gomc,lammps,namd,util}.rstpostprocessors/alchemlyb.postprocessors.units.rstpreprocessing/alchemlyb.preprocessing.subsampling.rstworkflows/alchemlyb.workflows.base.rstDuplicate object descriptions from
autosummary+autoclass:Added
:no-index:toautoclassdirectives in individual API pages. Theautosummarytables in parent pages already register these classes in Sphinx's index; the detailed API pages now render the full documentation without creating duplicate index entries.estimators/alchemlyb.estimators.{BAR,MBAR,TI,TI_GQ}.rstworkflows/alchemlyb.workflows.{ABFE,base}.rstconvergence/alchemlyb.convergence.convergence.rstRST / docstring fixes:
parsing/alchemlyb.parsing.lammps.rst: Fixed title underline length (was 1 char too short)estimators/alchemlyb.estimators.TI.rst: Renamed labelestimators_TItoestimators_TI_apito avoid collision with the same label inestimators-ti.rstsrc/alchemlyb/parsing/namd.py: Replaced invalid:param:fep_filesrole withfep_files``src/alchemlyb/visualisation/convergence.py: Normalized mixed 5-space / 4-space docstring indentation to consistent 4-space forplot_convergenceandplot_block_average, fixing "Unexpected section title" errorsSuppress unresolvable sklearn warnings:
docs/conf.py: Addedsuppress_warnings = ["ref.ref", "ref.term"]to silence warnings from inherited scikit-learn docstrings that reference internal sklearn labels (metadata_routing) and glossary terms (meta-estimator) we cannot resolve.Test plan
make clean htmlin docs/ produces 0 code-related warnings (only 6 SSL/network warnings from intersphinx on local builds, which do not appear on CI/ReadTheDocs)