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

Implement a function that generate the .md documentation file from the parsed structure. #21

Open
gaspardcereza opened this issue Jul 2, 2020 · 2 comments

Comments

@gaspardcereza
Copy link
Member

Context

I implemented a function parse_doc that parses the documentation of a function and returns a structure that contains the following information:

|.summary (string)
|
|.syntax (array of strings of size 1*nSyntaxes)
|
|.description (string)
|
|.inputs (struct)
|           \______ .names (array of strings of size 1*nInputs)
|            \______ .description (array of strings of size 1*nInputs)
|
|.outputs (struct)
|           \______ .names (array of strings of size 1*nInputs)
|            \______ .description (array of strings of size 1*nInputs)
|
|.notes (string)

We now want to generate a .md file destined to display the documentation on our website.

@jcohenadad
Copy link
Member

related to #20

@rtopfer
Copy link
Contributor

rtopfer commented Jul 2, 2020

We now want to generate a .md file destined to display the documentation on our website.

I may have misunderstood, but if you want to integrate the parsed+reformatted doc into the current workflow, then it wouldn't be a question of "generating" a .(new) md file so much as just swapping-out part of the original doc string with your new reformatted part, as I suggested here

e.g. just add an option (e.g. isParsingHeader=[true|false]) to the Documentor.draftdoccontent method to call your function within this for loop (i.e. for every .md file in the list)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants