Skip to content

[DocGen]: add module name field #819

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

Merged

Conversation

aspeddro
Copy link
Contributor

@aspeddro aspeddro commented Sep 24, 2023

This is useful for generating submodule titles.

@aspeddro aspeddro changed the title [DocGenadd module name field [DocGen]: add module name field Sep 24, 2023
@zth zth merged commit 5b828ba into rescript-lang:doc-extraction Sep 24, 2023
zth pushed a commit that referenced this pull request Oct 9, 2023
zth added a commit that referenced this pull request Oct 9, 2023
* basic doc extraction

* basic extraction of linkables

* prefer resi file when available, and prefer module signature vs impl

* temporary command for extracting docs

* add id:s and signatures for constructors/record fields

* produce what id to link to in linkables

* linkables in constructor and record field details

* fix linkable link ids

* field name, and fix double escaping

* remove linkables concept

* support extracting module aliases

* first tests

* update tests

* remove location field

* only emit deprecated

* remove location field

* add module name field (#819)

* [DocGen]: Rename key `item` -> `items` (#821)

* rename to items

* update tests

* docgen: convert items to array (#822)

* [DocGen]: Polish (#796)

* emit items from module alias

* add error msg

* rename fields

* remove double name field

* add ocaml.text attr

* search for all attrs

* fix id module

* update tests

* emit valid id path

* update tests

* docgen: polish (#825)

---------

Co-authored-by: Pedro Castro <[email protected]>
@aspeddro aspeddro deleted the doc-extraction-add-module-name branch October 12, 2023 02:04
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.

2 participants