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: use NUnit and DocFx to create examples #385

Open
6 of 10 tasks
mcavigelli opened this issue Mar 6, 2021 · 0 comments
Open
6 of 10 tasks

Docs: use NUnit and DocFx to create examples #385

mcavigelli opened this issue Mar 6, 2021 · 0 comments
Assignees
Labels

Comments

@mcavigelli
Copy link
Collaborator

mcavigelli commented Mar 6, 2021

As maintainers of the software, we want to be able to change and create the documentation with little effort.

Currently the examples use ExamplesFx, which is not maintained anymore and not widely used.
We would like to generate the documentation with NUnit as examples runner and docfx mean to write documentation. The tools should be runnable with .Net Standard 2, as we also will try to target .Net Standard with our software.

Currently the Examples are not contained in the buildconfigurations.

Tasklist

  • replace ExamplesFx with an own base class
  • include in build
  • change structure: each example has its own directory
  • extract input text with real files in each directory
  • use NUnit to execute the tests
    • fix ignored tests
  • save console output to console.txt file in each test directory
  • include creation in build
  • in examples replace file pattern to #regions in order to make it easy to target it from markdown files
  • generate markdown files for each example by extracting embedded comments which targeted ExamplesFx
@mcavigelli mcavigelli self-assigned this Mar 6, 2021
@mcavigelli mcavigelli added this to In progress in Doc improvement Mar 6, 2021
mcavigelli added a commit that referenced this issue Mar 17, 2021
#385 Standard docs: make examples executable with NUnit
@mcavigelli mcavigelli removed this from In progress in Doc improvement Aug 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant