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

Implement an html documentation generator similar to haddock (#1413) #1416

Conversation

janmasrovira
Copy link
Collaborator

@janmasrovira janmasrovira commented Jul 26, 2022

The 1st iteration of the design of juvix documentation is almost a copy of haddock with the linuwial theme. I've changed some colors following the palette that juvix.org uses in the landing page
Currently the generated documentation consists of:

  1. index with the tree of all modules reachable from the main module (which modules show up should be refined in the future)
  2. A page for each module with its signatures documented and linked identifiers
  3. Pretty printed source code of each module with linked identifiers

To test it

cd examples/milestone/MiniTicTacToe
juvix internal doc --open MiniTicTacToe.juvix

Note that the open flag will not work on Mac since it uses xdg-open internally. This will need to be fixed in a later PR

Next I think it would be a good idea to replace the existing html command with the new doc command

@janmasrovira janmasrovira linked an issue Jul 26, 2022 that may be closed by this pull request
@janmasrovira janmasrovira force-pushed the 1413-implement-an-html-documentation-generator-similar-to-haddock branch from a42fe61 to d771900 Compare July 28, 2022 06:45
@janmasrovira janmasrovira marked this pull request as ready for review July 28, 2022 13:47
@jonaprieto
Copy link
Collaborator

Great work!

@jonaprieto jonaprieto merged commit 2532b34 into main Jul 28, 2022
@jonaprieto jonaprieto deleted the 1413-implement-an-html-documentation-generator-similar-to-haddock branch July 28, 2022 15:19
@jonaprieto jonaprieto added this to the 0.2.3 milestone Aug 15, 2022
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

Successfully merging this pull request may close these issues.

Implement an html documentation generator similar to Haddock
2 participants