Commit 9d7296eb authored by Tristan Van Berkom's avatar Tristan Van Berkom

doc: Overhaul of page names and titles

 o Giving main pages simple word titles

   This makes the main page:

   * About
   * Installing
   * Using
   * Reference
   * Contributing

 o Now named all rst files with their parent page name as a prefix.

 o Also changed some titles to make overall consistent titles.
parent 53bc7272
Pipeline #23746423 passed with stages
in 34 minutes and 25 seconds
Hacking on BuildStream
======================
Contributing
============
Some tips and guidelines for developers hacking on BuildStream
......
About BuildStream
-----------------
About
-----
.. image:: https://gitlab.com/BuildStream/buildstream/badges/master/pipeline.svg
:target: https://gitlab.com/BuildStream/buildstream/commits/master
......
......@@ -18,7 +18,7 @@
# Authors:
# Tristan Van Berkom <tristan.vanberkom@codethink.co.uk>
"""
Source - base source class
Source - Base source class
==========================
......
......@@ -6,5 +6,5 @@ Additional writings
.. toctree::
:maxdepth: 2
cachekeys
sandboxing
additional_cachekeys
additional_sandboxing
Project format
==============
This section details how to use the BuildStream YAML format to
create your own project or modify existing projects.
.. toctree::
:maxdepth: 2
:caption: Project format
format_intro
format_project
format_declaring
format_public
format_project_refs
......@@ -2,8 +2,8 @@
.. _core_framework:
Core framework
--------------
Plugin API reference
====================
The core public APIs are of interest to anyone who wishes to
implement custom :mod:`Element <buildstream.element>` or
:mod:`Source <buildstream.source>` plugins, and can also be
......
Authoring projects
==================
This section details how to use the BuildStream YAML format to
create your own project or modify existing projects.
.. toctree::
:maxdepth: 2
:caption: Project format
formatintro
projectconf
format
public
projectrefs
Plugins
-------
Plugin specific documentation
=============================
Plugins provide their own individual plugin specific YAML configurations,
The element ``.bst`` files can specify plugin specific configuration in
the :ref:`config section <format_config>`, while sources declared on a
......@@ -27,7 +10,7 @@ given element specify their plugin specific configuration directly
General elements
~~~~~~~~~~~~~~~~
----------------
.. toctree::
:maxdepth: 1
......@@ -40,7 +23,7 @@ General elements
Build elements
~~~~~~~~~~~~~~
--------------
.. toctree::
:maxdepth: 1
......@@ -57,7 +40,7 @@ Build elements
Sources
~~~~~~~
-------
.. toctree::
:maxdepth: 1
......
Element constructs
Declaring elements
==================
......
......@@ -17,7 +17,7 @@ Later sections provide detailed information on BuilStream internals.
.. toctree::
:maxdepth: 1
about
main_about
main_install
main_using
main_core
......
Reference documentation
=======================
Reference
=========
This section details the core API reference along with
other more elaborate details about BuildStream internals.
......@@ -9,7 +9,8 @@ other more elaborate details about BuildStream internals.
.. toctree::
:maxdepth: 2
authoring
core_format
core_plugins
core_framework
core_additional
......
Installing
==========
Install
=======
This section covers how to install BuildStream onto your machine, how to run BuildStream inside a docker image and also how to configure an artifact server.
.. toctree::
:maxdepth: 2
install
docker
artifacts
install_main
install_docker
install_artifacts
Using BuildStream
=================
Using
=====
This section details how to use the BuildStream command line interface and work with existing BuildStream projects.
.. toctree::
:maxdepth: 2
examples
user_config
commands
using_examples
using_config
using_commands
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment