Skip to content
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

Auto Documentation problem #189

Open
digger-yu opened this issue May 31, 2023 · 0 comments
Open

Auto Documentation problem #189

digger-yu opened this issue May 31, 2023 · 0 comments

Comments

@digger-yu
Copy link

digger-yu commented May 31, 2023

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
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

No branches or pull requests

1 participant