eosnetworkfoundation / docsgen

Scripts for creating docs.eosnetwork.com pulls from various eos nf repos and builds static HTML to power website
Other
3 stars 0 forks source link

Links to functions in reference documentation need to be fixed urls #12

Open iamveritas opened 2 years ago

iamveritas commented 2 years ago

this is how a link to the function modify() in the mandel.cdt reference documentation gets generated: http://localhost:8080/mandel-cdt/group__multiindex.html#ga4b3556ef69c7faa917f185ae33a34442

the anchor seems to be a GUID which will be different each time the doc gets generated we need these anchors to be fixed so we can use them in docs and link to functions reference documentation.

Later edit: the GUIDs are generated the same way (fixed) all the time but we could improve

  1. the double underscores could be simplified
  2. instead of GUIDs have integers?... or a human readable anchor
ericpassmore commented 2 years ago

partially fixed in new release. Just need distinct URLs for each function. Specifically same name different arguments.

greg7mdp commented 1 year ago

I think the links are missing a '/' character in them to be correct.

They should be:
http://localhost:8080/mandel-cdt/group__multiindex.html/#ga4b3556ef69c7faa917f185ae33a34442
instead of
http://localhost:8080/mandel-cdt/group__multiindex.html#ga4b3556ef69c7faa917f185ae33a34442

On this page the links to anchors are broken as well.