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.

Sign up for GitHub

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

Jump to bottom

Haddock-like HTML output for disco documentation #327

Open
byorgey opened this issue Feb 11, 2022 · 1 comment
Open

Haddock-like HTML output for disco documentation #327

byorgey opened this issue Feb 11, 2022 · 1 comment
Labels
C-Project A larger project that may take multiple days. S-Moderate Moderate importance U-Standard Library Z-Documentation Z-Feature Request

Comments

@byorgey
Copy link
Member

byorgey commented Feb 11, 2022 •
edited
Loading

We should be able to generate web pages with documentation, especially for standard library modules. For example, see how Haddock does this for Haskell: https://hackage.haskell.org/package/haddock . Note that we should probably stick to using some standard, well-supported markup format such as Markdown.

The idea would be to generate an HTML listing of functions and types defined in a given module, with nicely typeset types, documentation and examples/tests, with a way to also see the source code.

See also #339.
@byorgey byorgey added C-Project A larger project that may take multiple days. Z-Feature Request Z-Documentation U-Standard Library S-Moderate Moderate importance labels Mar 31, 2022
@byorgey byorgey mentioned this issue Apr 28, 2022
Open
@byorgey
Copy link
Member Author

byorgey commented Jan 30, 2023

This is definitely not urgent and probably won't happen for a while, or until someone looking to make a big contribution picks it up.

@byorgey byorgey changed the title Haddock-like output for disco Haddock-like HTML output for disco documentation Oct 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
C-Project A larger project that may take multiple days. S-Moderate Moderate importance U-Standard Library Z-Documentation Z-Feature Request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@byorgey