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

docgen: don't create compiler's docs + cleanup #13509

Merged
merged 1 commit into from
Feb 26, 2020

Conversation

narimiran
Copy link
Member

No description provided.

@Araq Araq merged commit 9a93f73 into nim-lang:devel Feb 26, 2020
@timotheecour
Copy link
Member

not sure why you removed compiler docs, I miss https://nim-lang.github.io/Nim/compiler/ast.html etc; it helps when working on compiler

@genotrance
Copy link
Contributor

Nightlies on windows has been broken since this was added.

@timotheecour
Copy link
Member

hmm, do you have a link? maybe when not defined(windows): ... would be less drastic?

@narimiran
Copy link
Member Author

I miss https://nim-lang.github.io/Nim/compiler/ast.html etc; it helps when working on compiler

...and there is no other way for you to build those docs locally to help you?? 🙄

@timotheecour
Copy link
Member

timotheecour commented Feb 27, 2020

that would require me to keep patching the compiler to locally revert you PR when working on compiler code (and then remembering to un-patch it when pushing a new PR) ; not exactly convenient.
Many nimble packages have nim doc generated pages available online, eg https://nitely.github.io/nim-regex/regex.html or http://c-blake.github.io/cligen/parseopt3.html
This makes it easy to both get a quick overview and as a reference.
compiler is itself a nimble package, and a rather important one; so I'm not sure why having online docs wouldn't make sense

@Araq
Copy link
Member

Araq commented Feb 27, 2020

Generated docs for Nim compiler itself do make sense, yes. However, it makes no sense these identifiers end up in theindex.html etc. We either should do it properly or not at all.

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.

4 participants