Commit Graph

3 Commits

Author SHA1 Message Date
Robert Helmer
d289dba01d Bug 1389341 - add basic support for sphinx-js to mach doc r=gps
MozReview-Commit-ID: FIzWD8tnjYi
2017-09-14 13:17:09 -07:00
Maja Frydrychowicz
23c57c6ad2 Bug 1411430 - Support markdown in Sphinx docs; r=gps
MozReview-Commit-ID: IdRuC4AFarq
2017-10-23 09:59:31 -04:00
Gregory Szorc
8808487bf8 Bug 1395752 - Define and use sparse profile for Sphinx docs; r=dustin
The Sphinx documentation only needs access to a relatively small number
of files in the repo in order to be generated. It is a good candidate
for using sparse profiles.

This commit defines and uses a "sphinx-docs" sparse profile containing
only the files relevant to Sphinx documentation generation.

There are some quirks with the profile:

* All moz.build files are included. This bloats the profile
  by >1000 files. Worse, it realizes directories that have no business
  being realized. This clutters the checkout and makes it harder to
  find things. There is a moz.build reader that knows how to retrive
  file data from Mercurial. We could use that. This feels like follow-up
  fodder.

* All mach_commands.py files are included. `mach help` says you can do
  things that you aren't able to do in the sparse checkout. There isn't
  a good way to add all *.py files while excluding mach_commands.py
  files. We /could/ do it with regular expressions. But those are slow.
  Let's leave it as is for now and come up with a better solution later.

MozReview-Commit-ID: 7yiqGGE1nAh
2017-08-22 22:25:38 -07:00