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

Ideal pipeline for documented packages with many packages #105

Open
Datseris opened this issue Oct 26, 2022 · 0 comments
Open

Ideal pipeline for documented packages with many packages #105

Datseris opened this issue Oct 26, 2022 · 0 comments

Comments

@Datseris
Copy link

Datseris commented Oct 26, 2022

Hi,
I discussed on Slack what I would like to have as an ideal pipeline for documenting packages like DynamicalSystems.jl. Here it is:

  • each package has standard Documenter.jl docs, or any docs that allow documenter syntax (@docs and @example blocks). For example: https://juliadynamics.github.io/Entropies.jl/dev/ . Each package builds and deploys its own docs as normal. Some cross-referenced links that point to docs of functions in different packages will not work, but that is okay. Having each package build its own docs is useful during development, because ideally each Pull Request should add its documentation, and we would like to be able to preview it.
  • Hence, like Documenter.jl does, the documenting package I use should allow for documentation previews in pull requests.
  • The central repo, for me DynamicalSystems.jl, includes all these docs. It could be done in the way it is done now, and puts a new side bar top-level entry for each package, https://juliadynamics.github.io/DynamicalSystems.jl/dev/ (in the Sidebar there is an expandable Entropies, or ChaosTools, or whatever entry)
  • Alternative to the side bar is the overarching bar that SciML MultiDocumenter has, see the top of this page: https://docs.sciml.ai/Overview/stable/ . Either format is fine for me, I don't really care. I am using the side bar format now, but could give a try on the "top bar" format.
  • In the DynamicalSystems.jl repo, I set up a github action that triggers its doc build every couple of days or so, so that if a package has a new release, the "central" docs are updated.
  • The most important features I care about are: (1) cross-referencing documentation strings of other functions. E.g., Entropies has function foo that referneces function ChaosTools.bar and that reference is actually clickable in the built docs. (2) Being able to go to the source code of each function from the central documentation. At the moment, Documenter.jl allows accessing the source code of the function ONLY For the module that builds the docs.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant