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

Add a docs build (with error checking) option to the dev_menu.py script #13682

Merged
merged 1 commit into from
Jan 4, 2019

Conversation

aaronmarkham
Copy link
Contributor

Description

This PR extends the dev_menu.py script to give it a docs build option. 馃敟
It leverages the existing deploy_docs function from CI that is basically a straight call to make docs SPHINXOPTS=-W. This will check your build for docs errors, so this makes it just a little more easier to test your dev work before making a PR.

As with any make docs run, make sure you update /docs/settings.ini to choose which doc sets to run, otherwise you're running them all! 馃槻

Comments

Unrelated to this change is that while getting the script to function, I noticed the script has a couple of deviations in requirements from a standard user installation of MXNet. These aren't in our user setup scripts:

  1. yaml Python module (pip install)
  2. ccache (apt install)

So to run this script you need these!

I tried using a docker variation for giggles and ran into security issues at one point, so there are probably some additional config steps to make the docker options work for a regular user.

It also requires Python 3. It will fail to run on Python 2 (around line 75). I think that since we still support Python 2 the script should be updated accordingly. Again, this has nothing to do with this feature I'm adding. I'm just commenting on the current situation with the script that is already in the repo.

Experimental

I experimented with adding an option to run the full website build since that would be pretty cool to offer for easy dev & testing, but I put that off after seeing that it's not quite setup to handle a bunch of parameters. Sure, it could be done, but I didn't want to make so many changes without discussing the best approach. I had a --website option going that took in the 5 params needed, but then found I'd need to rewrite/extend the commands functions, so I didn't. Saving this kind of update for later since I'd also like to make it easy to pick which doc set(s) to run (python/c/scala/java/clojure/r/etc). Ping me if anyone wants to help with that.

@Roshrini
Copy link
Member

@mxnet-label-bot Add [Doc, pr-awaiting-review]

@marcoabreu marcoabreu added Doc pr-awaiting-review PR is waiting for code review labels Dec 19, 2018
@aaronmarkham
Copy link
Contributor Author

@larroy - added this feature per your suggestion. Also, I have some comments about the script in this PR's description. In particular, I'd want to sync up the dependencies and make sure those are in the setup scripts... yaml is fine, but do we need to require ccache? I'm ok either way... just not sure if a basic build option really needs that.

@Roshrini
Copy link
Member

Roshrini commented Jan 2, 2019

@larroy @nswamy Can you review this PR?

Copy link
Contributor

@larroy larroy left a comment

Choose a reason for hiding this comment

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

LGTM

@aaronmarkham aaronmarkham merged commit 0165ef4 into apache:master Jan 4, 2019
rondogency pushed a commit to rondogency/incubator-mxnet that referenced this pull request Jan 9, 2019
haohuanw pushed a commit to haohuanw/incubator-mxnet that referenced this pull request Jun 23, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Build Doc pr-awaiting-review PR is waiting for code review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants