Add SoftwareX citation info and improve docs landing page#45
Merged
Caparrini merged 3 commits intoscikit-learn-contrib:masterfrom Feb 20, 2026
Merged
Add SoftwareX citation info and improve docs landing page#45Caparrini merged 3 commits intoscikit-learn-contrib:masterfrom
Caparrini merged 3 commits intoscikit-learn-contrib:masterfrom
Conversation
Add citation information for the accepted SoftwareX paper across multiple surfaces: CITATION.cff for GitHub's cite button, DOI badge and citing section in README, dedicated Sphinx docs page, announcement banner, and paper link in PyPI project URLs.
Set root_doc to readme_link so visitors see the project README as the first page. Moved toctree into readme_link.rst and removed the now-redundant index.rst.
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
1 participant
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.
Citation and Documentation Updates:
CITATION.cfffile to the repository, providing standardized citation metadata for themloptimizersoftware, including authors, article details, and DOI.README.mdto include a DOI badge and a new "Citing" section with citation instructions and BibTeX entry. [1] [2]citing.rstsection in the documentation with citation instructions and BibTeX, and linked it from the documentation sidebar. [1] [2]setup.pyproject URLs for greater discoverability.Documentation Structure Improvements:
index.rstfile and restructured documentation navigation to start fromreadme_link.rst, improving organization and making citation information more prominent. [1] [2]Build/Dependency Maintenance:
setuptoolsinrequirements_docs.txtto improve documentation build stability.docs/sections/citing.rst — dedicated docs page + announcement banner in conf.py
setup.py — "Paper" link in PyPI project URLs
Docs landing page: