[GitHub] aaronmarkham commented on issue #11916: [MXNET-744] Sphinx error reduction

[GitBox <gi...@apache.org>]

aaronmarkham commented on issue #11916: [MXNET-744] Sphinx error reduction
URL: https://github.com/apache/incubator-mxnet/pull/11916#issuecomment-409683553
 
 
   **UPDATE:**
   Part of the problem is changes I make here are not viewable in the full site build pipeline as that checks out from specific branches on the main repo and not my fork. Then each legacy version only uses the configurations it has and not any updates I make here.
   So... while I can fix the current build, the builds for every other version are still buggy as hell. :confounded:
   
   I'm working on the tooling now so that you can supply logic from your fork/branch and supply that as an arbitrary version in the build. This process also is belabored by every version and every API build which makes for test cycles of about 40 minutes.  I'm updating the build tools to turn on/off documentation sets via a config file instead of how they're hard-coded in the Sphinx plugin file, mxdoc.py. I've got it down to 18 minutes for all versions.
   
   This has led to certain realizations. 
   :bulb: We're probably going to have to refactor the docs build process, so that we have better control.
   :bulb: Each version should be built separately and maintained separately, rather than an overlapping pipeline.
   :bulb: Each version should be built with configurations held in master, or... 
   :bulb: We're probably going to have to make some commits to the old version branches to fix legacy bugs, so that we're not doing hot patches during every build. 
   :bulb: Maybe we can cache old versions and not have to rebuild every time. Then builds can be done in a few minutes. 
   :bulb: And finally, maybe I can actually debug whatever is going on with this Sphinx theme! Or if anyone really knows Sphinx theme customization and how this code works, they can help address why the left navigation behaves unexpectedly now that index files and table of contents are being supplied as per Sphinx's documentation. Basically, it seems to copy state from previous views and when you toggle between versions --> shenanigans.
   
   Any help would be appreciated. :pray:

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services