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.

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

[Documentation] uneven '*' character --> Error '*' expected #6910

Closed
mratsim opened this issue Dec 12, 2017 · 1 comment
Closed

[Documentation] uneven '*' character --> Error '*' expected #6910

mratsim opened this issue Dec 12, 2017 · 1 comment
Labels
Documentation Content Related to documentation content (not generation). Tools

Comments

@mratsim
Copy link
Collaborator

mratsim commented Dec 12, 2017

I'm trying to use nim doc on a file with a dependency on @andreaferretti Nimcuda.

nim doc fails for any line with uneven number of star characters. As far as I know nimcuda documentation is autogenerated by c2nim and have a lot of such:

cublas_api.nim(139, 52)

  ##  cublasSetVector (int n, int elemSize, const void *x, int incx, 
  ##                   void *y, int incy)

cuda_occupency(265, 4)

##  If *blockSize is 0, then the given combination cannot run on the device.

Error is:

Error: '*' expected
@mratsim mratsim changed the title [Documentation] '*' --> Error '*' expected [Documentation] uneven '*' character --> Error '*' expected Dec 12, 2017
@andreaferretti andreaferretti added Documentation Content Related to documentation content (not generation). Tools labels Dec 13, 2017
@Araq
Copy link
Member

Araq commented Dec 13, 2017

The doc gen uses reStructuredText. Fix your documentation.

@Araq Araq closed this as completed Dec 13, 2017
mratsim added a commit to mratsim/Arraymancer that referenced this issue May 5, 2018
@mratsim
OpenCL docs: remove * - nim-lang/Nim#6910
3db65d8
mratsim added a commit to mratsim/Arraymancer that referenced this issue May 5, 2018
@mratsim
Update for V0.4.0 (#224)
f5f434f 
* Temporarily remove OpenCL destructors nim-lang/Nim#7776

* Use the defined(nimdoc) flag for documentation

* OpenCL docs: remove * - nim-lang/Nim#6910

* Temporarily remove Cuda destructors

* Temporarily remove CuDNN destructors: nim-lang/Nim#7776

* Fix doc gen "new section expected"

* delete old autogen_nim_API

* Nimble now copies the CSS

* Slightly improve #169, doc truncated instead of being unusable on small width

* Put some doc on network dsl

* Generate docs for the new files and Cuda/CuDNN files

* Fix navigation disappearing immediately when hovering out

* Update supported features

* delete deprecated Cuda BLAS internal proc

* Add a changelog for 0.4.0
@mratsim mratsim mentioned this issue Jan 10, 2019
Open
@mratsim mratsim mentioned this issue Jan 5, 2021
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation Content Related to documentation content (not generation). Tools
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@Araq @andreaferretti @mratsim