Skip to content

Auto Documentation problem #189

@digger-yu

Description

@digger-yu

added auto-doc #175

The user can embed something like {{ autodoc:colossalai.amp.apex_amp.convert_to_apex_amp }} in his markdown files and this will be converted to React code for its docstring in MDX.

The actual effect is not particularly perfect

Take this link as an example
https://colossalai.org/docs/basics/booster_api
image

  1. When I click on source, the redirect link is a 404
    image
  2. In addition, the display style of autodoc is different from the display style of the code under this page
    image
  3. I found that clicking on all the source buttons that use autodoc redirects to 404
    image
  4. all the "Edit this page" button link error
    image

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions