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

Add reference docs generation using docma #4

Merged
merged 2 commits into from
May 13, 2019
Merged

Conversation

olle
Copy link
Contributor

@olle olle commented May 12, 2019

  • Adding support for the minimal generate reference documentation
    using docma. Running npm run docs or npm run serveDocs will
    generate documentation from the source-files using docma.

    This branch still does not commit the generated ./docs output
    since it is still just used to try out and get a feel for how
    the generated documentation looks and behaves.

Please note that this is initially only for evaluation, whether the generated documentation is nice, pretty or good enough for use in for example a generated Github-page.

* Adding support for the minimal generate reference documentation
  using docma. Running `npm run docs` or `npm run serveDocs` will
  generate documentation from the source-files using docma.

  This branch still does not commit the generated `./docs` output
  since it is still just used to try out and get a feel for how
  the generated documentation looks and behaves.
@olle olle requested review from fheft and removed request for fheft May 12, 2019 11:03
@olle olle assigned olle, fheft and stwa May 12, 2019
@stwa
Copy link
Contributor

stwa commented May 12, 2019

I think it's a good idea and it actually looks pretty nice! I played a bit with jsdoc and found that I could not get typedefs to show up properly with docma (see https://devhints.io/jsdoc for an example). Is it something we need (right now)?

@fheft
Copy link
Contributor

fheft commented May 13, 2019

Looks nice indeed!

@stwa Typedefs looked okay for me at first glance, what issues did you find?

@olle
Copy link
Contributor Author

olle commented May 13, 2019

I like the look-and-feel a lot. At the moment there's not that good support for a regular modular JS project though - everything is global and modules are not picked up by default etc.

I guess it's up to us to find the right way to do jsdoc, and tweak the configuration, if we want to move forward with this rendered.

I suggest we do similar branches for other tools too.

@stwa stwa merged commit 744ac85 into master May 13, 2019
@stwa stwa deleted the try-docma-for-js-docs branch May 13, 2019 11:42
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.

None yet

3 participants