Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a script to generate documentation from template library annotations #46

Open
jouvin opened this issue Jul 6, 2014 · 8 comments
Open

Comments

@jouvin
Copy link
Contributor

jouvin commented Jul 6, 2014

More and more annotations are added, at least for public variable, in the template library. SCDB allows to generate XML files from these annotations (ant compile.annotions). It'd be good to have a script to process these XML files and generate html or markdown files from them.

@jouvin jouvin added this to the 14.10 milestone Jul 6, 2014
@jrha jrha modified the milestones: 14.12, 14.10 Oct 1, 2014
@jrha
Copy link
Member

jrha commented Oct 1, 2014

Bumped to next release at workshop.

@jrha jrha changed the title Add a script to generate documentation from template library annotiations Add a script to generate documentation from template library annotations Dec 5, 2014
@jrha jrha modified the milestones: 15.4, 14.12 Dec 5, 2014
@wdpypere
Copy link
Contributor

wdpypere commented Mar 4, 2015

As discussed in the workshop we will attempt to document the schema with annotations. we need:

  • a example on how to do it
  • a way of parsing the output xml
    • with xslt?
    • a python script was mentioned to parse these. Any have the location of this?

@jrha
Copy link
Member

jrha commented Mar 4, 2015

I believe @njwilliams had something once upon a time...

@jrha
Copy link
Member

jrha commented Mar 11, 2015

I have the source from MS, I am sanitising and de-morganising it. I will open a PR soon.

@wdpypere
Copy link
Contributor

good news!

@jrha
Copy link
Member

jrha commented Mar 13, 2015

See #78, I have tested it successfully against several repositories, it will need some changes to produce the documentation we want though.

@jrha
Copy link
Member

jrha commented Jun 2, 2015

@wdpypere?

@wdpypere
Copy link
Contributor

@jrha I will be adding schema documentation based on the panc annotations to the component documentation on readthedocs, but documenting an entire template library is not in my scope today. Although the code supplied in #78 would be a very good start for anyone having a go at it.

@jrha jrha modified the milestones: 15.10, 15.8 Aug 26, 2015
@jrha jrha modified the milestones: 16.2, 15.12 Dec 7, 2015
@jrha jrha removed this from the 16.2 milestone Feb 12, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

3 participants