Skip to content

DRAFT prototyping for in-repo .md comp/instr docs#2404

Open
willend wants to merge 44 commits intomccode-dev:mainfrom
willend:mcdoc-multiple-output-formats
Open

DRAFT prototyping for in-repo .md comp/instr docs#2404
willend wants to merge 44 commits intomccode-dev:mainfrom
willend:mcdoc-multiple-output-formats

Conversation

@willend
Copy link
Copy Markdown
Contributor

@willend willend commented Apr 16, 2026

Free-form text area

Please describe what your PR is adding in terms of features or bugfixes:

The mcdoc in this PR supports multiple output formats: html, md and TeX. NOT YET finalised.

Use-cases:

  • Generation of .md docs in the repo
  • TeX snippets for the comp-manual

Development OS / boundary conditions

Please describe what OS you developed and tested your additions on, and if any special dependencies are required:


PR Checklist for contributing to McStas/McXtrace

For a coherent and useful contribution to McStas/McXtrace, please fill in relevant parts of the checklist:

  • My contribution contains something else

    • Explanation is added in free form text above or below the checklist

@willend
Copy link
Copy Markdown
Contributor Author

willend commented Apr 21, 2026

Now includes .md files pr (McStas) component and TeX snippets generated (imperfectly) for inclusion in the PDF manuals...

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

Successfully merging this pull request may close these issues.

1 participant