Tutorial

[NiJen]

Hi Patrick,
Im pretty new to sphinx, it is possible that you can attach a little tutorial or example for the vhdl domain?
Or a link where i can found more Information?

And how can I install or copy the doamin in my sphinx enviroment to use it?

[Paebbels]

This repository is not ready to be used yet. See this issue: #1

[NiJen]

Okay it is possible to help you with the development? Im new to sphinx but i can programm in python and vhdl.

[Paebbels]

Sorry for my late response.

I was not able to focus more an the project. It's not dead, but delayed. So if you want to help, your help is highly appreciated and welcome!

I think, at first we should specify the required ReST format for entities, architectures, types, ...
That's where I stopped. The code is a copy of another domain (I think it is/was .NET/C#). These domain is very complex compared to other domains and supports nested language constructs as we will find them in VHDL: function in an architecture.

Next would be to adapt the existing .NET domain to our VHDL needs.

If this sounds like a plan to you go on and suggest merges. If you like, I can also grant direct access for your user account :).

[Paebbels]

I personally, think the Sphinx code is a mess ... they don't use e.g. classes to organize data, but tuples. Yes that's fast but no one knows what index contains what elements. At least I haven't found any (nor good) documentation about the used tuple formats.

So whenever you find some information, please add comments to the newly generated VHDL domains :).

[Paebbels]

This repository (as longtime placeholder) is now actively used to create a automatic documentation extension for VHDL using Sphinx.

First proof-of-concept looks like this:

Automatic Documentation of a VHDL Entity

Please see #5 for more details.