Skip to content

Conversation

davesnx
Copy link
Contributor

@davesnx davesnx commented Oct 15, 2025

ODOC(1)     Odoc Manual         ODOC(1)

NAME
       odoc

SYNOPSIS
       odoc [COMMAND] …

COMMANDS: Compilation pipeline
      aggregate-occurrences [--file-list=FILE] [--strip-path] [OPTION]…
      [FILE]…
      Aggregate hashtables created with odoc count-occurrences.

      classify [OPTION]… [DIR]…
      Classify the modules into libraries based on heuristics. Libraries
      are specified by the --library option.

-     markdown-generate [--extra-suffix=SUFFIX] [--sidebar=FILE.odoc-sidebar]
-     [--syntax=SYNTAX] [OPTION]… FILE.odocl
-     Generate markdown files from a .odocl.

-     markdown-generate-source [OPTION]… FILE.ml
-     Generate markdown files from a impl-*.odocl.

      sidebar-generate [--json] [OPTION]… FILE
      Generate a sidebar from an index file.

      support-files [--without-theme] [OPTION]…
      Copy the support files (e.g. default theme, JavaScript files) to the output directory.

COMMANDS: Alternative generators
      latex-generate [OPTION]… FILE.odocl
      Generate latex files from a .odocl.

      man-generate [--extra-suffix=SUFFIX] [--sidebar=FILE.odoc-sidebar]
      [--syntax=SYNTAX] [OPTION]… FILE.odocl
      Generate man files from a .odocl.

+     markdown-generate [--extra-suffix=SUFFIX] [--sidebar=FILE.odoc-sidebar]
+     [--syntax=SYNTAX] [OPTION]… FILE.odocl
+     Generate markdown files from a .odocl.

+     markdown-generate-source [OPTION]… FILE.ml
+     Generate markdown files from a impl-*.odocl.

@davesnx davesnx changed the title Change from pipeline to generators Change markdown-* from pipeline to generators Oct 15, 2025
@jonludlam jonludlam added the no changelog This pull request does not need a changelog entry label Oct 16, 2025
@jonludlam
Copy link
Member

Thanks!

@jonludlam jonludlam merged commit 969cc4f into ocaml:master Oct 16, 2025
11 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no changelog This pull request does not need a changelog entry

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants