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

Docs: Generate the Examples from the code #49

Closed
MarcosMeli opened this issue Jun 25, 2015 · 3 comments
Closed

Docs: Generate the Examples from the code #49

MarcosMeli opened this issue Jun 25, 2015 · 3 comments
Milestone

Comments

@MarcosMeli
Copy link
Owner

Based on the original idea of ExamplesFx try to create the HTML of the examples from the Examples solution of the library

In the issue #39 there are some related discussions

@MarcosMeli MarcosMeli added this to the 3.1 Release milestone Jun 25, 2015
@mcavigelli
Copy link
Collaborator

Thanks for giving me the opportunity to explain it better. In issue #39 some things were unclear:

About Roslyn I was thinking in the inverse, use the standard visual studio solution with ExamplesFx, parse it with Roslyn and generate the markdown pages and the exe app.
Also the pages will contains the output generated when we ran the examples Run the examples, capture the output, can be a bit harder but has the help of visual studio writting the examples, can you provide an example for your idea to understand a bit more

The workflow could be

  1. write examples in Visual Studio and have them compiled (as it is mostly now) ie dynamic_record_example.cs.
  2. have a kramdown file per example with the explanations (no source code), dynamic_record_example.md
    1. dynamic_record_example.md has prepared (empty) code blocks, indicating the contents (csv, csharp)
    2. these code blocks contain a comment pointing to dynamic_record_example.cs (with line range, region, other)
  3. That's how is checked-in in the master branch.
  4. For updating the page a script/application comes and reads the comment in 2.ii and pulls the source code into a copy of the dynamic_record_example.md (probably an output folder).
    1. copy of dynamic_record_example.md file contains now source code
  5. copy of dynamic_record_example.md file with source code must be copied to the gh-pages branch.

This looks to me 😉 flexible (csv and csharp files can be pulled into prepared example) and similar to known solutions (as in asciidoc).

@MarcosMeli
Copy link
Owner Author

I just finish to generate the first deployable examples

The ExamplesFx library uses roslyn to parse the files, compile them and generate the html docs and later the tt code

http://www.filehelpers.net/examples/

@MarcosMeli
Copy link
Owner Author

Some examples are ok now, pending review on some others and we need to add some Excel examples

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

No branches or pull requests

2 participants