<feed xmlns='http://www.w3.org/2005/Atom'>
<title>delta/buildstream.git/doc/source/plugin.rsttemplate, branch fetch-committers</title>
<subtitle>gitlab.com: buildstream/buildstream.git
</subtitle>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/buildstream.git/'/>
<entry>
<title>doc: Added plugins as ToC elements instead of orphaned links</title>
<updated>2018-06-09T21:14:10+00:00</updated>
<author>
<name>Tristan Van Berkom</name>
<email>tristan.vanberkom@codethink.co.uk</email>
</author>
<published>2018-06-09T21:14:10+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/buildstream.git/commit/?id=055b77e8e9b7ab6ffdfcad8d01c0f20737dbd3dd'/>
<id>055b77e8e9b7ab6ffdfcad8d01c0f20737dbd3dd</id>
<content type='text'>
  o Now the page titles are declared in plugins, allowing for
    a more descriptive ToC

  o Makefile and plugin.rsttemplate updated to not produce the title,
    to no longer use `:orphan:` for plugin pages, and to ignore any
    private modules in the plugin directories.

  o Interestingly, now the docs will fail to build if you add
    a new plugin and forget to add it to the documentation.
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
  o Now the page titles are declared in plugins, allowing for
    a more descriptive ToC

  o Makefile and plugin.rsttemplate updated to not produce the title,
    to no longer use `:orphan:` for plugin pages, and to ignore any
    private modules in the plugin directories.

  o Interestingly, now the docs will fail to build if you add
    a new plugin and forget to add it to the documentation.
</pre>
</div>
</content>
</entry>
<entry>
<title>Documentation: Fix warnings, and make all warnings errors.</title>
<updated>2018-01-04T15:25:34+00:00</updated>
<author>
<name>Tristan Van Berkom</name>
<email>tristan.vanberkom@codethink.co.uk</email>
</author>
<published>2018-01-04T14:10:41+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/buildstream.git/commit/?id=4625bfb0b2c9e40349a9ea5945ec4c3aea83d11e'/>
<id>4625bfb0b2c9e40349a9ea5945ec4c3aea83d11e</id>
<content type='text'>
Some of the warnings from sphinx-build are really just warnings,
but a lot of the things we want to avoid and really break documentation,
like broken internal references and some invalid rst directives should
really be errors.

Now we treat all warnings as errors, this should ensure that
any commits landing upstream never break the docs.
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Some of the warnings from sphinx-build are really just warnings,
but a lot of the things we want to avoid and really break documentation,
like broken internal references and some invalid rst directives should
really be errors.

Now we treat all warnings as errors, this should ensure that
any commits landing upstream never break the docs.
</pre>
</div>
</content>
</entry>
<entry>
<title>Added __init__.py to the plugin subdirectories.</title>
<updated>2017-05-24T11:28:37+00:00</updated>
<author>
<name>Tristan Van Berkom</name>
<email>tristan.vanberkom@codethink.co.uk</email>
</author>
<published>2017-05-24T11:26:24+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/buildstream.git/commit/?id=25325b0d6f8dc93e2bd40d3f81637c36bf0b3158'/>
<id>25325b0d6f8dc93e2bd40d3f81637c36bf0b3158</id>
<content type='text'>
This makes the 'sources' and 'elements' subdirectores modules technically,
but it does not effect how we load them with pluginbase, that still works.

Updated documentation machinery to have buildstream/plugins in the PYTHONPATH
and import the docs as elements.autotools etc.

This is all because since recent sphinx started importing from distutils,
this was conflicting with our distutils plugin.
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
This makes the 'sources' and 'elements' subdirectores modules technically,
but it does not effect how we load them with pluginbase, that still works.

Updated documentation machinery to have buildstream/plugins in the PYTHONPATH
and import the docs as elements.autotools etc.

This is all because since recent sphinx started importing from distutils,
this was conflicting with our distutils plugin.
</pre>
</div>
</content>
</entry>
<entry>
<title>Docs hacking</title>
<updated>2016-12-13T07:03:52+00:00</updated>
<author>
<name>Tristan Van Berkom</name>
<email>tristan.vanberkom@codethink.co.uk</email>
</author>
<published>2016-12-12T06:36:00+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/buildstream.git/commit/?id=7664a686fb10c1d2b0909c6a94284b89c4aa39ee'/>
<id>7664a686fb10c1d2b0909c6a94284b89c4aa39ee</id>
<content type='text'>
Replace sphinx-apidoc for plugin API docs generation.
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Replace sphinx-apidoc for plugin API docs generation.
</pre>
</div>
</content>
</entry>
</feed>
