Граф коммитов

18 Коммитов

Автор SHA1 Сообщение Дата
ogiorgis b42b079b39 Bug 1803426 - upload images not in a `docs` folder and fix warnings r=firefox-source-docs-reviewers,ahal DONTBUILD
Differential Revision: https://phabricator.services.mozilla.com/D167942
2023-02-07 15:32:37 +00:00
Greg Mierzwinski ea27aaab13 Bug 1803428 - Add docs for mach try perf, and allow images in perfdocs. r=perftest-reviewers,afinder DONTBUILD
This patch adds docs for the mach try perf tool, and also allows images to be used in all parts of perfdocs (only PNGs though).

Differential Revision: https://phabricator.services.mozilla.com/D163514
2022-12-02 12:44:10 +00:00
Mark Banner f9083f6df7 Bug 1780017 - Add mjs files to files that may be used for generating jsdocs. r=firefox-source-docs-reviewers,ahal
Differential Revision: https://phabricator.services.mozilla.com/D152329
2022-07-22 08:25:44 +00:00
Mitchell Hentges 23cbe80fd0 Bug 1724274: Move virtualenv dependency manifests to python/virtualenvs r=ahal
This is needed for a few reasons:
* All mach commands can use virtualenvs, not just `build`-related
  commands, so the files don't make sense to be in `build/`.
* When locking is added, more files associated with virtualenvs will be
  added, and this will change will ease the related directory structure
  setup.
* This removes the need for a redundant "_virtualenv_packages" keyword
  as part of the manifest filenames.

Differential Revision: https://phabricator.services.mozilla.com/D140382
2022-03-24 14:04:34 +00:00
Mitchell Hentges 75d14b24c3 Bug 1717104: Align virtualenv_name with requirements definition r=ahal
Maps virtualenvs one-to-one with their associated requirements
definition.

For example:
```
Name: "docs"
Virtualenv location: <snip>/_virtualenvs/docs
Requirements location: $topsrcdir/build/docs_virtualenv_packages.txt
```

An issue to be resolved in the future is that it's tricky to know that,
when you define a new virtualenv, you have to *know* that a requirements
definition needs to exist in `build/`.

As part of this change, the default virtualenv ("common") was
split from the build virtualenv ("build").
This required changes to the python-test virtualenv since
python-tests depend on `glean_parser`, but were getting it
implicitly from the "build" virtualenv's requirements.
This addition to the `python-test` virtualenv is temporary and
will be removed when bug 1724273 is resolved.

Differential Revision: https://phabricator.services.mozilla.com/D122891
2021-09-13 15:42:53 +00:00
Chris H-C f666fb3dc9 Bug 1705403 - Replace FOG's Glean autodocs with link to Glean Dictionary r=janerik DONTBUILD
Differential Revision: https://phabricator.services.mozilla.com/D114631
2021-05-10 13:33:09 +00:00
Mark Banner dae9d6efad Bug 1498604 - Make './mach doc' use jsdoc installed into node_modules rather than the system. r=mossop,ahal
Differential Revision: https://phabricator.services.mozilla.com/D111652
2021-04-14 13:35:20 +00:00
Chris H-C a0efcbcf74 Bug 1673660 - C++ and JS API for Glean Custom Pings r=janerik,webidl,smaug
Covers adding the new JS global `GleanPings` for JS, the new structs for C++ at
mozilla::glean_pings, ping-id and string-table-index codegen, the usual
boilerplate for JS and C++ stuff, and tests.

Unresolved:
* What happens if we call this on a non-parent process?
  (This isn't a supported mode of operation)

Differential Revision: https://phabricator.services.mozilla.com/D98671
2020-12-14 16:50:07 +00:00
Jan-Erik Rediger 4b11c48d2a Bug 1646165 - Make the test metrics file known to sphinx. r=janerik CLOSED TREE
Differential Revision: https://phabricator.services.mozilla.com/D94445
2020-10-22 14:02:00 +00:00
Chris H-C 5493409c18 Bug 1654339 - Add Glean metrics autodocs to moztreedocs r=janerik,ahal
Also define a scheme for storing the index of Glean definitions files in a file
separate from the build system for consumption by
* mach build
* mach doc
* (future) mozilla/probe-scraper

Differential Revision: https://phabricator.services.mozilla.com/D87600
2020-08-21 16:30:45 +00:00
Sylvestre Ledru be715d2f73 Bug 1644123 - mach doc: Provides the full path to logo and favicon + update of the build sparse config r=firefox-source-docs-reviewers,ahal
Differential Revision: https://phabricator.services.mozilla.com/D78671
2020-06-08 19:06:44 +00:00
Ethan Glasser-Camp 7cd2a98da0 Bug 1606026: Move existing documentation into new locations r=sylvestre
Differential Revision: https://phabricator.services.mozilla.com/D58338

--HG--
rename : tools/docs/docs/contribute/mozilla_source_code_directory_structure.rst => docs/contributing/directory_structure.rst
rename : tools/docs/docs/contribute/how_to_contribute_firefox.rst => docs/contributing/how_to_contribute_firefox.rst
rename : tools/docs/docs/adding-documentation.rst => tools/moztreedocs/docs/adding-documentation.rst
rename : tools/docs/docs/index.rst => tools/moztreedocs/docs/index.rst
rename : tools/docs/docs/mdn-import.rst => tools/moztreedocs/docs/mdn-import.rst
extra : moz-landing-system : lando
2020-01-06 16:38:34 +00:00
Ethan Glasser-Camp 6f164aa98f Bug 1606026: Move documentation entry point to docs/ r=sylvestre
Differential Revision: https://phabricator.services.mozilla.com/D58552

--HG--
rename : tools/docs/conf.py => docs/conf.py
rename : tools/docs/config.yml => docs/config.yml
rename : tools/docs/index.rst => docs/index.rst
rename : tools/docs/jsdoc.json => docs/jsdoc.json
extra : moz-landing-system : lando
2020-01-06 16:14:11 +00:00
Ethan Glasser-Camp 0549c56796 Bug 1606026: move tools/docs code to tools/moztreedocs r=sylvestre
Differential Revision: https://phabricator.services.mozilla.com/D58337

--HG--
rename : tools/docs/Pipfile => tools/moztreedocs/Pipfile
rename : tools/docs/Pipfile.lock => tools/moztreedocs/Pipfile.lock
rename : tools/docs/moztreedocs/__init__.py => tools/moztreedocs/__init__.py
rename : tools/docs/_static/custom_theme.css => tools/moztreedocs/_static/custom_theme.css
rename : tools/docs/mach_commands.py => tools/moztreedocs/mach_commands.py
rename : tools/docs/moztreedocs/package.py => tools/moztreedocs/package.py
rename : tools/docs/moztreedocs/upload.py => tools/moztreedocs/upload.py
extra : moz-landing-system : lando
2020-01-06 16:29:21 +00:00
Johan Lorenzo 00b90ced7a Bug 1468751 - Add images in documentation sparse checkout r=gps
Add images in documentation sparse checkout

Differential Revision: https://phabricator.services.mozilla.com/D1663
2018-06-15 00:00:05 +00:00
Robert Helmer 42315c18f8 Bug 1389341 - add basic support for sphinx-js to mach doc r=gps
MozReview-Commit-ID: FIzWD8tnjYi

--HG--
extra : rebase_source : 655ea46cffefda77f0908924fdbbb8d17212654a
2017-09-14 13:17:09 -07:00
Maja Frydrychowicz 1fe7490b20 Bug 1411430 - Support markdown in Sphinx docs; r=gps
MozReview-Commit-ID: IdRuC4AFarq

--HG--
extra : rebase_source : f0b6c72340920fad49ab06887cd25db436c82897
2017-10-23 09:59:31 -04:00
Gregory Szorc 7be30dd863 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

--HG--
extra : rebase_source : c148040ea3618e8bfdd369b6f48fc60c6d179285
extra : source : b76e2f6204b20de137f2566dff8121ff3abe5760
2017-08-22 22:25:38 -07:00