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

cryptol-remote-api: render docs as artifact or use simpler rst #1208

Open
pnwamk opened this issue Jun 1, 2021 · 2 comments
Open

cryptol-remote-api: render docs as artifact or use simpler rst #1208

pnwamk opened this issue Jun 1, 2021 · 2 comments
Labels
docs LaTeX, markdown, literate haskell, or in-REPL documentation remote-api Related to Cryptol's remote API

Comments

@pnwamk
Copy link
Contributor

pnwamk commented Jun 1, 2021

#1207 much improves our documentation for the low-level details of the server, but the .rst generated contains some features (e.g., custom anchors) that do not render nicely in Github's file browser/explorer UI. Should we generate HTML/PDF/etc documentation artifacts as a part of the build that fully render the .rst correctly? Or consider simplifying what kind of .rst we generate?

@pnwamk pnwamk added docs LaTeX, markdown, literate haskell, or in-REPL documentation remote-api Related to Cryptol's remote API labels Jun 1, 2021
@atomb
Copy link
Contributor

atomb commented Aug 13, 2021

We could consider rendering it to HTML (using Sphinx, maybe?) and make it available using GitHub pages.

@pnwamk
Copy link
Contributor Author

pnwamk commented Aug 13, 2021

If we render the reference manual somewhere convenient (#1260) then we could also render these docs there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs LaTeX, markdown, literate haskell, or in-REPL documentation remote-api Related to Cryptol's remote API
Projects
None yet
Development

No branches or pull requests

2 participants