Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

Fix generated html docs javascript error. #13240

Closed
wants to merge 1 commit into from

Conversation

frankfliu
Copy link
Contributor

@frankfliu frankfliu commented Nov 13, 2018

Description

Extra :noindex causes javascript error in html pages, which renders an empty page.
Remove extra :noidex in the model_zoo.md and io.md file.

Verified output html pages are working fine locally.

Build output can be found:
http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-13240/1/api/python/index.html#io-api

http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-13240/1/api/python/gluon/model_zoo.html

Checklist

Essentials

Please feel free to remove inapplicable items for your PR.

  • Changes are complete (i.e. I finished coding on this PR)
  • All changes have test coverage:
  • Unit tests are added for small changes to verify correctness (e.g. adding a new operator)
  • Nightly tests are added for complicated/long-running ones (e.g. changing distributed kvstore)
  • Build tests will be added for build configuration changes (e.g. adding a new build option with NCCL)
  • Code is well-documented:
  • For user-facing API changes, API doc string has been updated.
  • For new C++ functions in header files, their functionalities and arguments are documented.
  • For new examples, README.md is added to explain the what the example does, the source of the dataset, expected performance on test set and reference to the original paper if applicable
  • Check the API doc at http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-$PR_ID/$BUILD_ID/index.html
  • To the my best knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change

@frankfliu frankfliu requested a review from szha as a code owner November 13, 2018 01:10
@zachgk
Copy link
Contributor

zachgk commented Nov 13, 2018

@mxnet-label-bot add [Doc, Bug]

Copy link
Contributor

@aaronmarkham aaronmarkham left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this other PR goes through that fixes the js...
#13246
Will we even need to make this change?

@frankfliu
Copy link
Contributor Author

With #13246, the page won't render empty any more. But this fix is still needed to keep one index target.

@frankfliu
Copy link
Contributor Author

frankfliu commented Nov 13, 2018

@mxnet-label-bot add [pr-awaiting-review]

@marcoabreu marcoabreu added the pr-awaiting-review PR is waiting for code review label Nov 13, 2018
@aaronmarkham
Copy link
Contributor

@vandanavk vandanavk mentioned this pull request Nov 13, 2018
5 tasks
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Bug Doc pr-awaiting-review PR is waiting for code review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants