[GitHub] aaronmarkham opened a new issue #10858: make docs on Mac - scala docs failure

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

aaronmarkham opened a new issue #10858: make docs on Mac - scala docs failure
URL: https://github.com/apache/incubator-mxnet/issues/10858
 
 
   ## Description
   Making docs on a Mac is broken if you use the latest version of scala, maven, and sbt.
   
   ## Minimum reproducible example
   On a Mac, run `make docs`.
   Unrelated, but this actually fails unless you do `make` first.
   
   Then you'll see you need some dependencies like in the [setup_docs_ubuntu script](https://github.com/apache/incubator-mxnet/blob/master/docs/build_version_doc/setup_docs_ubuntu.sh) and then follow up with these to make sure you're getting the system installs for Mac (you must have Sphinx 1.5.6 just like CI):
   ```
   pip install sphinx==1.5.6
   brew install maven
   brew upgrade maven
   brew install sbt
   brew install scala
   make
   make docs
   ```
   That's pretty much what I had to do to get the docs to get even close to building on the Mac.
   But, then it will fail when it tries to move some scala docs files that don't exist.
   
   ## What have you tried to solve it?
   
   I sort of solved it, but it isn't something I think I can commit because it might break what's happening in CI on Ubuntu.
   
   1. Remove `index` and `package.html` from [mxdoc.py line 89](https://github.com/apache/incubator-mxnet/blob/master/docs/mxdoc.py#L89)
   2. Run `make docs` again and it's fine. Even better than fine, because the docs seem to be much more modern and usable than the current docs.
   
   ## Comments
   
   If you get stuck building docs locally with a Mac, do what I did in step 1 above. 
   I'd like to see how to upgrade the Ubuntu scaladocs in CI to what I'm seeing on the Mac. CI docker setup uses no version info when installing the scala deps, so it's not obvious at the moment. Acquiring a different version of scala deps would need to be thoroughly tested since it could break any number of other things. 

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