Drop api-auto-docs for now

[khsrali]

When using the search bar, all un-related api results is shown and makes it incredibly difficult to fetch the result of actual documentation.

I first, aimed to remove api-doc from the search results. But sphinx doesn't allow it. I struggled two hours with no success.
@edan-bainglass also looked up these references:
https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_search_scorer
https://docs.readthedocs.com/dev/latest/search-integration.html

Unfortunately it seems not doable. Or requires two days of work to make it.
We suggest to drop api-auto-docs for now, as an urgent solution. If one finds a solution in future they can safely revert this PR/commit.

[khsrali]

Houston, We Have a Problem!
all the cross references fail, now.. because api is overly referenced elsewhere 😭

[GeigerJ2]

Classic example of "should be quick" :/ good luck with this, guys, you will need it :D

[danielhollas]

@khsrali @edan-bainglass have you seen this page? https://docs.readthedocs.com/platform/stable/config-file/v2.html#search

It looks like the ranking needs to be configured in the .readthedocs.yml. We actually already have a negative rank for apidoc, but I think the path is wrong.

aiida-core/.readthedocs.yml

Line 34 in cf690e4

reference/apidoc/*: -7

Can you try changing reference/apidoc/* to reference/api/*?

See also discussion in the original PR at #4217

[danielhollas]

Can you try changing reference/apidoc/* to reference/api/*?

Sorry, I was wrong. But I think it's still worth investigating if the existing configuration can be fixed I think.

[mbercx]

@khsrali you inspired me: aiidateam/aiida-quantumespresso#1186

(along with the AutoAPI docs failing again on a totally random PR: aiidateam/aiida-quantumespresso#1185)

Re the references: I've "fixed" the issue by simply adding a line to the nitpick_ignore_regex in my conf.py:

nitpick_ignore_regex = [
    ...
    (r'py:.*', r'aiida_quantumespresso.*'),
]

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.28%. Comparing base (cfbbd68) to head (9d46775).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #7056      +/-   ##
==========================================
- Coverage   79.29%   79.28%   -0.00%     
==========================================
  Files         566      566              
  Lines       43847    43847              
==========================================
- Hits        34763    34760       -3     
- Misses       9084     9087       +3     

☔ 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.

[khsrali]

The results already has improved quite a lot without autodoc.
If @edan-bainglass agrees, I'd say let's merge this for now.

[edan-bainglass]

@khsrali have you looked into @danielhollas's suggestion? #7056 (comment)

[khsrali]

@edan-bainglass

reference/apidoc/ is the correct path. I tried to reduce the score from -7 to even lower numbers, but it didn't help.

[edan-bainglass]

reference/apidoc/ is the correct path. I tried to reduce the score from -7 to even lower numbers, but it didn't help.

Okay. Sorry, I don't have time to check this. @danielhollas seems to think this is the right path. Maybe have a look at the referenced PR for inspiration. If all else fails, you can proceed with this one. I'll approve now.

[edan-bainglass]

LGTM!