.clang-format
author Andrew Halberstadt <ahalberstadt@mozilla.com>
Fri, 18 Jan 2019 20:10:18 +0000
changeset 514472 19b949191e5c5680fca1edae111352eaa0a688aa
parent 508917 1b641c848a60987464e438095f426baa66702086
child 514505 5f4630838d46dd81dadb13220a4af0da9e23a619
permissions -rw-r--r--
Bug 1484691 - [doc] Don't add doctrees nested under other doctrees to the root index r=nalexander Currently, it's possible to nest doctrees underneath one another by doing this: SPHINX_TREES['foo'] = 'docs' SPHINX_TREES['foo/bar'] = 'bar/docs' (note: the 'bar' doctree doesn't need to be a subdir of foo and can be defined in a completely separate moz.build) Doing this means that the docs in 'bar' will be nested underneath the docs in 'foo' when sphinx-build ultimately runs. This allows us to add 'bar' to foo's index, essentially making bar a subdoc of foo. The problem is that we also add bar's docs to the root index here: https://searchfox.org/mozilla-central/rev/dac799c9f4e9f5f05c1071cba94f2522aa31f7eb/tools/docs/moztreedocs/__init__.py#133 The result is that the main landing page for firefox-source-docs is a big long list of random unrelated topics. There is no organization or cohesion. By excluding subdocs from the main index, we can start to move pages around into some kind of organization that makes sense. Actually moving those docs will be a lot of work, but at least this will give us the ability. Differential Revision: https://phabricator.services.mozilla.com/D16869

BasedOnStyle: Google

# Prevent the loss of indentation with these macros
MacroBlockBegin: "^\
JS_BEGIN_MACRO|\
NS_INTERFACE_MAP_BEGIN|\
NS_INTERFACE_TABLE_HEAD|\
NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION|\
NS_IMPL_CYCLE_COLLECTION_.*_BEGIN|\
NS_INTERFACE_TABLE_HEAD_CYCLE_COLLECTION_INHERITED|\
NS_INTERFACE_TABLE_BEGIN|\
NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN_INHERITED|\
NS_IMPL_CYCLE_COLLECTION_UNLINK_BEGIN_INHERITED|\
NS_QUERYFRAME_HEAD$"
MacroBlockEnd: "^\
JS_END_MACRO|\
NS_INTERFACE_MAP_END|\
NS_IMPL_CYCLE_COLLECTION_.*_END|\
NS_INTERFACE_TABLE_END|\
NS_INTERFACE_TABLE_TAIL.*|\
NS_INTERFACE_MAP_END_.*|\
NS_IMPL_CYCLE_COLLECTION_TRAVERSE_END_INHERITED|\
NS_IMPL_CYCLE_COLLECTION_UNLINK_END_INHERITED|\
NS_QUERYFRAME_TAIL.*$"

SortIncludes: false