Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Using DocumenterInterLinks #365

Open
sethaxen opened this issue Oct 24, 2024 · 1 comment
Open

Using DocumenterInterLinks #365

sethaxen opened this issue Oct 24, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@sethaxen
Copy link
Member

Since Documenter v1.3.0, Documenter has been including Sphinx inventory files in the docs build. DocumenterInterLinks.jl then provides functionality for specifying a package whose docstrings we want to be able to link to.

Instead of duplicating the API docs of our component packages here, we should instead simply re-export each package, deferring to their documented APIs. Then the docs for this meta-package would focus on usage examples that combine the component packages, linking to the corresponding docstrings in each package.

The only not-great aspect of this plan has to do with the docstrings for functions in MCMCDiagnosticTools and PosteriorStats that have new methods defined in extensions in InferenceObjects. Currently those docstrings are only included here. If using DocumenterInterLinks here, we should define those docstrings in the InferenceObjects docs. This will still result in docstrings for various methods of e.g. rhat being spread out across multiple docs pages for different packages, but this won't be so bad if InferenceObjects also uses DocumenterInterLinks to link in each overload's docstring back to the more abstract method defined in the original package.

@sethaxen sethaxen added the documentation Improvements or additions to documentation label Oct 24, 2024
@sethaxen
Copy link
Member Author

DimensionalData builds its docs using DocumenterVitepress.jl, which seems to not include the inventory file we would need. See LuxDL/DocumenterVitepress.jl#189

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant