nest / nestml

A domain specific language for neuron and synapse models in spiking neural network simulation
GNU General Public License v2.0
46 stars 45 forks source link

Improve documentation generation for models #712

Open jougs opened 2 years ago

jougs commented 2 years ago

Large parts of the model documentation can be generated from the model code, but this seems not to be done consistently. Thing I noticed:

clinssen commented 2 years ago

The See also section should be removed in favor of a list of keywords that can either be auto-generated or supplied by the user.

Isn't this exactly what the See also section is?

jougs commented 2 years ago

Yes and no. The See also section in the NESTML (and many NEST models for that matter) is populated with a list of related models like iaf_psc_alpha and such. However, if the NEST doc extractor sees that such a section exists, it will replace its content with links to the model directory for all tags that are listed after the doc start marker /* BeginUserDocs:. Check out the documentation of iaf_psc_alpha for an example.

I see three issues here:

jougs commented 2 years ago

I still think that some additional blocks would help for this:

neuron iaf_psc_alpha:

  short_description: A leaky integrate-and-fire neuron with alpha-shaped post-synaptic currents
  keywords: integrate-and-fire, current-based
  author: The NEST Initiative

  description:
    blub
  end

  references:
    [1]
  end

  equations:
    ...