sojiadeshina commented on a change in pull request #16392: [WIP] Improving Python Docs API URL: https://github.com/apache/incubator-mxnet/pull/16392#discussion_r332824481
########## File path: docs/python_docs/_static/autodoc.js ########## @@ -0,0 +1,49 @@ +/*! + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +/* Customizations to the Sphinx auto module plugin output */ +function auto_index() { + var targets = $("dl.class>dt,dl.function>dt"); Review comment: Sure. Essentially what's going on is it's going through all the classes/methods on the page and truncating the name to just the last two parts i.e from something like `mxnet.gluon.nn.contrib` to just `nn.contrib` and then adding that to a list that can be toggled so that the sidebar has information and anchors to specific methods on the page even when the sphinx toc-tree doesn't. @ThomasDelteil wrote this part so he can correct me if i missed anything or give a more detailed description of what's going on. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
