-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
The file 'dochack.js' not generated with the documentation #8952
Labels
Documentation Generation
Related to documentation generation (but not content).
Comments
andreaferretti
added
Tools
Documentation Content
Related to documentation content (not generation).
labels
Sep 12, 2018
dochack.js is not enough; theindex.html is also needed:
|
krux02
added
Documentation Generation
Related to documentation generation (but not content).
and removed
Documentation Content
Related to documentation content (not generation).
labels
Oct 21, 2018
Now it's built with |
verified this now works locally including
EDIT: /cc @Araq |
mjfh
added a commit
to status-im/nimbus-eth1
that referenced
this issue
Jan 18, 2022
why: Some helper file will not be generated by the nim document gereator, so they have been stashed from a later nim version to be provided when missing. This problem was known with an earlier nim version (see here nim-lang/Nim#8952) but was reported solved. Maybe we need a second look into that.
zah
pushed a commit
to status-im/nimbus-eth1
that referenced
this issue
Jan 22, 2022
why: Some helper file will not be generated by the nim document gereator, so they have been stashed from a later nim version to be provided when missing. This problem was known with an earlier nim version (see here nim-lang/Nim#8952) but was reported solved. Maybe we need a second look into that.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The
doc
anddoc2
commands produce an HTML document which relies on a file nameddochack.js
. Since the commands do not generate this file, most of the documentation's dynamic functionalities are broken.Minimal example
Make a file called
sample.nim
with the following content:Run the
doc
commands as described in the official documentation:Open the generated
sample.html
file and try to group entries or use the search bar. The operation should fail and an error should be reported in the console.Conclusion
dochack.js
file), that should also be mentioned in the onlinedocgen
documentation. In addition, I would propose to disable said functionalities in a more obvious way like not having them appear in the HTML at all (instead of them silently failing).The text was updated successfully, but these errors were encountered: