Skip to content

WIP generate markdown docs from eep48 docs#36

Open
uwiger wants to merge 1 commit intomasterfrom
uw-eep48
Open

WIP generate markdown docs from eep48 docs#36
uwiger wants to merge 1 commit intomasterfrom
uw-eep48

Conversation

@uwiger
Copy link
Owner

@uwiger uwiger commented Oct 11, 2025

The idea:

EDoc supports generation of doc chunks from edoc syntax, using e.g. a config like this:

{edoc_opts,
  [{doclet, edoc_doclet_markdown},
   {preprocess, true},
   {layout, edoc_layout_chunks}]}.

Running rebar3 edoc with this config once, will insert -moduledoc chunks into the source corresponding to the old edoc comments. It would be nice to be able to delete the old edoc after this, and still generate the same kind of documentation.

This PR (WIP) checks if there is a doc chunk for a module, and extracts descriptions from it if legacy edoc descriptions are missing (if they're not missing, they are used instead).

Only tested so far, with some success, for module-level and function-level @doc tags.

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

Comments