Add option to set :noindex: by saimn · Pull Request #150 · astropy/sphinx-automodapi

saimn · 2022-04-20T20:53:47Z

TODO: see if I can add a test for this.

codecov · 2022-04-20T20:55:42Z

Codecov Report

Merging #150 (c029e0e) into main (c4aa837) will increase coverage by 0.59%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main     #150      +/-   ##
==========================================
+ Coverage   89.31%   89.90%   +0.59%     
==========================================
  Files          24       27       +3     
  Lines        1104     1139      +35     
==========================================
+ Hits          986     1024      +38     
+ Misses        118      115       -3

Impacted Files	Coverage Δ
sphinx_automodapi/automodapi.py	`93.93% <100.00%> (+0.18%)`	⬆️
sphinx_automodapi/automodsumm.py	`85.71% <100.00%> (+0.08%)`	⬆️
...pi/tests/duplicated_warning/duplicated/__init__.py	`100.00% <100.00%> (ø)`
...ests/duplicated_warning/duplicated/foo/__init__.py	`100.00% <100.00%> (ø)`
...api/tests/duplicated_warning/duplicated/foo/foo.py	`100.00% <100.00%> (ø)`
...utomodapi/tests/example_module/abstract_classes.py	`64.28% <100.00%> (+5.46%)`	⬆️
sphinx_automodapi/tests/test_cases.py	`100.00% <100.00%> (ø)`
sphinx_automodapi/utils.py	`91.30% <100.00%> (+0.47%)`	⬆️
sphinx_automodapi/autodoc_enhancements.py	`100.00% <0.00%> (+4.76%)`	⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

saimn · 2022-05-06T20:23:22Z

Wasn't easy but I managed to add a test :)
Who wants to review ?

saimn · 2022-05-06T20:54:37Z

All green now :)

pllim · 2022-05-06T21:04:13Z

Ooooo... how do we use this in astropy? Does it just magically work?

saimn · 2022-05-06T21:15:50Z

No magic :D, we must add :noindex: to the duplicated directives, and this PR just propagates :noindex: to autodoc.

pllim · 2022-05-09T16:33:52Z

@saimn , is there an astropy PR that uses this feature? Would be nice to see if it really works before we merge.

sphinx_automodapi/tests/test_cases.py

saimn · 2022-05-19T14:07:03Z

is there an astropy PR that uses this feature? Would be nice to see if it really works before we merge.

@pllim - no, I could do that indeed 👍

pllim · 2022-08-11T17:52:56Z

@saimn , any chance we can push this forward? Did you say there is something that not quite working still using this with astropy?

@WilliamJamieson is unable to build astropy docs on Python 3.10 because of the Sphinx maxversion pin.

saimn · 2022-12-02T18:36:30Z

Within another round of testing/debugging on Astropy I'm pretty convinced that the changes here are correct and are doing what is supposed. Adding :noindex: should help fixing duplicate warning for simple cases such as https://github.com/maxnoe/sphinx-automodapi-duplicated-warning, and probably photutils. But for astropy it's not enough because of the complicated structure of the docs and code, using :noindex: there then creates some other warnings about missing references.

pllim · 2022-12-02T18:59:31Z

Is it time to make astropy less complicated?! We cannot pin Sphinx forever.

Cadair · 2022-12-07T10:02:52Z

Is it time to make astropy less complicated?!

I have been working on this for years 😛

Cadair

pllim · 2022-12-07T14:50:11Z

sphinx_automodapi/tests/duplicated_warning/docs/conf.py

@@ -0,0 +1,11 @@
+project = 'duplicated'
+copyright = '2022, Maximilian Nöthe'


LoL does @maxnoe consent to be immortalized as a test case like this? 😸

Though I am Maximilian Linhoff now ;)

sphinx_automodapi/tests/duplicated_warning/duplicated/foo/foo.py

pllim

Just some nitpicks. If you want to address them, great. If not, we can defer. Though that one typo should probably be fixed anyway before merge.

Let's ship this indeed and then fix up astropy! 🚀

sphinx_automodapi/tests/duplicated_warning/docs/conf.py

Cadair · 2022-12-09T17:08:58Z

Even though astropy core doesn't need this, we might as well merge it?

pllim · 2022-12-09T17:38:45Z

Gah, CI got disabled. I have to close/reopen.

pllim · 2022-12-09T17:49:01Z

Merged! I'll let someone else do the release. Thanks, all!

Add option to set :noindex:

0b85680

Fix astropy#130

saimn added this to the 0.15.0 milestone Apr 20, 2022

saimn added 2 commits May 6, 2022 21:09

Remove py2 compat code

da1dbc3

Add test

39cd650

This comment was marked as resolved.

Sign in to view

saimn force-pushed the noindex branch 2 times, most recently from 31365f9 to 3fed892 Compare May 6, 2022 20:33

saimn added 3 commits May 6, 2022 22:44

Fix package discovery

6f68814

Cleanup

209ec82

Include test files

d097d38

saimn force-pushed the noindex branch from 5b1fb9d to d097d38 Compare May 6, 2022 20:44

saimn requested a review from a team May 6, 2022 20:55

astrofrog reviewed May 19, 2022

View reviewed changes

sphinx_automodapi/tests/test_cases.py Show resolved Hide resolved

pllim mentioned this pull request Jun 20, 2022

Sphinx class inheritance diagrams not linking classes correctly astropy/astropy#4935

Closed

2 tasks

pllim mentioned this pull request Aug 30, 2022

DOC: Unpin max version of Sphinx when Sphinx 4.0.2 is out (and Jinja2) astropy/astropy#11725

Closed

saimn mentioned this pull request Dec 2, 2022

Unpin Sphinx astropy/astropy#14093

Closed

Cadair approved these changes Dec 7, 2022

View reviewed changes

pllim reviewed Dec 7, 2022

View reviewed changes

sphinx_automodapi/tests/duplicated_warning/duplicated/foo/foo.py Outdated Show resolved Hide resolved

pllim approved these changes Dec 7, 2022

View reviewed changes

pllim reviewed Dec 7, 2022

View reviewed changes

sphinx_automodapi/tests/duplicated_warning/docs/conf.py Outdated Show resolved Hide resolved

sphinx_automodapi/tests/duplicated_warning/docs/conf.py Outdated Show resolved Hide resolved

pllim mentioned this pull request Dec 9, 2022

Unpin sphinx alternative astropy/astropy#14140

Merged

10 tasks

Typos

e8bc34c

This comment was marked as resolved.

Sign in to view

pllim added 2 commits December 9, 2022 12:36

Comment out language = None

db86362

Merge branch 'main' into noindex

c029e0e

pllim closed this Dec 9, 2022

pllim reopened this Dec 9, 2022

pllim merged commit 6e476f2 into astropy:main Dec 9, 2022

saimn deleted the noindex branch December 9, 2022 18:22

pllim mentioned this pull request Apr 7, 2023

What is Public API astropy/astropy#13910

Open

This was referenced Apr 7, 2025

Reorganize astropy.units.physical as a sub-package astropy/astropy#17978

Open

cosmo: feat: “traits” module astropy/astropy#17702

Merged

		@@ -0,0 +1,11 @@
		project = 'duplicated'
		copyright = '2022, Maximilian Nöthe'

Uh oh!

Conversation

saimn commented Apr 20, 2022

Uh oh!

codecov bot commented Apr 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

saimn commented May 6, 2022

Uh oh!

This comment was marked as resolved.

saimn commented May 6, 2022

Uh oh!

pllim commented May 6, 2022

Uh oh!

saimn commented May 6, 2022

Uh oh!

pllim commented May 9, 2022

Uh oh!

Uh oh!

saimn commented May 19, 2022

Uh oh!

pllim commented Aug 11, 2022

Uh oh!

saimn commented Dec 2, 2022

Uh oh!

pllim commented Dec 2, 2022

Uh oh!

Cadair commented Dec 7, 2022

Uh oh!

Cadair left a comment

Choose a reason for hiding this comment

Uh oh!

pllim Dec 7, 2022

Choose a reason for hiding this comment

Uh oh!

maxnoe Dec 7, 2022

Choose a reason for hiding this comment

Uh oh!

maxnoe Dec 7, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

pllim left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Cadair commented Dec 9, 2022

Uh oh!

This comment was marked as resolved.

pllim commented Dec 9, 2022

Uh oh!

pllim commented Dec 9, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

codecov bot commented Apr 20, 2022 •

edited

Loading