JustinGOSSES / wellioviz

d3.js v5 visualization of well logs
https://justingosses.github.io/wellioviz/#introduction
Apache License 2.0
49 stars 12 forks source link

Can't figure out how to order functions in the docs using documentation.js seems like it isn't an option based on issue reports from 2017! #94

Closed JustinGOSSES closed 1 year ago

JustinGOSSES commented 4 years ago

Can't figure out how to order functions in the docs using documentation.js seems like it isn't an option based on issue reports from 2017!

THIS IS Supper ANNOYING but most big JavaScript seems to be built on JSDoc which has same limitations.

dcslagel commented 4 years ago

Is lists of the current order and the desired order?

Are these the steps to duplicate the problem?

How to Make the Docs

Thanks, DC

JustinGOSSES commented 4 years ago

Yes, those are the steps to replicate the problem.

Under the header "Wellioviz Function Types", I'd like to insert specific functions under each time. So for example, I'd like to insert the documentation for the curvebox() function under the "plotting functions" header which is under "Wellioviz function types".

The status quo is documentation.js puts the inline documentation for each function at the bottom of the docs in the order of the functions.

From issues in documentation.js it looks like documentation.js might not be able to positive functions if they are treated as module exports, which all wellioviz functions are. However, that's my interpretation as that isn't spelled out exactly anywhere.

JustinGOSSES commented 1 year ago

Determined this is a limitation with documentation.js