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

Explicit APIs for each "level" of documentation #219

Open
mortenpi opened this issue Jan 26, 2024 · 0 comments
Open

Explicit APIs for each "level" of documentation #219

mortenpi opened this issue Jan 26, 2024 · 0 comments

Comments

@mortenpi
Copy link
Member

DocumentationGenerator can generate multiple versions of the docs for a given package version: fallback readme + API, documenter docs, just the HTML readme.

Right now, that's all opaquely handled by the main build command. We should refactor the API such that it would be possible to explicitly request the generation of certain "type" of docs. This would create better interfaces, and also hopefully assist in testing.

We should also still retain the fallback logic, where we try the most complex option first, and then generate less sophisticated docs if that fails etc.

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