Repository navigation
docs: list every search and repair stale search docs and citations (search-extensibility A0c) - #1669
Merged
Merged
Conversation
- docs/api/searches.rst: add Nautilus, NSS, Drawer and MultiStartAdam / ADABelief / Lion / Prodigy, so all 15 exported searches are listed (autosummary stubs are generated at build time). - docs/cookbooks/search.md: add a Nautilus section between DynestyStatic and LBFGS; say the cookbook covers a selection of searches and link the API reference for the full list. - config/non_linear/README.md, docs/general/configs.md: only GridSearch.yaml lives there; per-search defaults are constructor arguments since #1202. - docs/installation/source.md: requirements.txt files no longer exist; use pip install -e PyAutoFit / -e "PyAutoFit[optional]". - files/citations.{bib,md}, files/citation.tex: drop MultiNest and PyMultiNest, add BlackJAX, optax and Prodigy, add Nautilus to the .md and .tex, use the sqlite2020 key that the .bib defines. Refs #1668 Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
This was referenced Oct 8, 2026
Collaborator
Author
… the docstring Listing NSS in docs/api/searches.rst made the docs build render this docstring, where docutils reported 'Unexpected indentation'. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
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
Search documentation and citation repair for the search-extensibility epic, phase A0c part 1 (PyAutoFit#1668).
docs/api/searches.rstnow lists all 15 searches (Nautilus, NSS, Drawer and the four MultiStart optimisers were missing); the search cookbook gains a Nautilus section and no longer claims to cover "every search"; thenon_linearconfig README andconfigs.mdstop describing per-search YAML files that do not exist (onlyGridSearch.yamllives there);installation/source.mduses editable installs instead of the missingrequirements.txtfiles; the citation files drop the MultiNest/PyMultiNest ghosts and add blackjax, optax, prodigy and Nautilus, with thesqlite2020key fixed. Docs-only: no source changes.API Changes
None. Documentation and citation files only.
Test Plan
sphinx-build -b htmllocally: succeeds (32 pre-existing warnings; one new from the NSS docstring now being rendered, tracked for A0b)grep -ri "pyswarms\|multinest" docs/ files/emptyFull API Changes (for automation & release notes)
Removed
Added
Migration
Generated by the PyAutoLabs agent workflow.
🤖 Generated with Claude Code