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

enable compiler docs with their own index+search #14493

Merged

Araq merged 2 commits into nim-lang:devel from timotheecour:pr_doc_compiler

May 29, 2020

Member

timotheecour commented May 29, 2020 •

edited

Loading

compiler docs, index and search are now generated (using a single command, which is now possible thanks to recent PR's)
no interference with existing index + search (ie, using separate indexes based on previous feedback; it'd still be nice to have a master index though)
remove code duplication in buildDocs

(changed --hint[Conf]:off to --hint:Conf:off so that you can copy paste commands without having to edit and quote arguments)

future work

address caveat https://github.com/nim-lang/Nim/pull/14493/files#diff-cdc1b5c3c94ae8670cc9a495b8647ba8R272
master template that links to compiler/theindex.html
in future, would be nice for the html template to allow navigating to both compiler docs + stdlib docs (ie a multi-package index; would be useful for other projects too; ideally it wouldn't need much hardcoding for nim repo)
multi-backend docs (eg for nim js docs)

timotheecour added 2 commits

May 29, 2020 01:07


          enable compiler docs (with its own index)

d5df260

53eae2f

Araq merged commit cb6eb52 into nim-lang:devel

timotheecour deleted the pr_doc_compiler branch

May 29, 2020 21:58

timotheecour mentioned this pull request

add std/syntaxes to hint syntax highlighters about string literals #17722

Closed

3 tasks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet