ModECI / modelspec

Functionality for specifying models & enabling automatic serialization - will be used by MDF & NeuroMLlite
https://modeci.github.io/modelspec/
Apache License 2.0
3 stars 9 forks source link

URL links for rst not formatted correctly #16

Closed pgleeson closed 2 years ago

pgleeson commented 2 years ago

See description here: https://github.com/ModECI/modelspec/blob/main/examples/document.rst#section

Propagating to docs being generated here: https://mdf.readthedocs.io/en/latest/api/Specification.html#id9

pgleeson commented 2 years ago

Probably an issue in here: https://github.com/ModECI/modelspec/blob/d04c5f66209884c9845f94b4876c1b034c1dd2cb/src/modelspec/base_types.py#L583

parikshit14 commented 2 years ago

@pgleeson while referring any sub section inside an RST document (what I got from internet ref ) instead of

<a href="#document">Document</a>

we must use

`Document`_ 

I tried hard-coding this and it works correctly i.e a hyperlink of sub section inside the RST doc is created and I will try to add this inside the

def insert_links

function.

this is what we want right?

pgleeson commented 2 years ago

@parikshit14 Yes, this is the idea. But see here: https://raw.githubusercontent.com/ModECI/modelspec/main/examples/document.rst, the links that work in https://github.com/ModECI/modelspec/blob/main/examples/document.rst#section are like

`Section <#section>`_

i.e. they need a lowercase anchor to the subsection...

pgleeson commented 2 years ago

Fixed in #18