Skip to content

GitLab

  • Menu
Projects Groups Snippets
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • dumux dumux
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 92
    • Issues 92
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 80
    • Merge requests 80
  • Deployments
    • Deployments
    • Releases
  • Packages & Registries
    • Packages & Registries
    • Container Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • Repository
  • Wiki
    • Wiki
  • Activity
  • Graph
  • Create a new issue
  • Commits
  • Issue Boards
Collapse sidebar
  • dumux-repositories
  • dumuxdumux
  • Merge requests
  • !1914

[examples] Implement Python-only doc generator using pyparsing

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Timo Koch requested to merge feature/python-examples-docgen into master Mar 27, 2020
  • Overview 26
  • Commits 16
  • Changes 25

Suggestion for a Python-only doc generator. It's using the library pyparsing. We used pyparsing in dune-testtools to parse input files and it's quite nice.

Supports:

  • [[codeblock]] [[/codeblock]]
  • [[exclude]] [[/exclude]]
  • Excludes license header and header guards
  • Removes extra lines at the end of code snippets

Should be easily extensible.

TODO

  • Correct double spaces in some of the source files
  • Get rid of doc above header guards
  • Walk recursively through the folder structure to create README.mds in subfolders if .doc_config is present --> fixed in a different way: .doc_config can now specifiy multiple targets (markdown documentation files) which are generated by a list of source files. This way we can generate as many markdown files as we want, call them what we want, and generate them in the subfolder we want.
Edited Mar 30, 2020 by Timo Koch
Assignee
Assign to
Reviewer
Request review from
Time tracking
Source branch: feature/python-examples-docgen