Commit 5aa20e85 authored by Jani Nikula's avatar Jani Nikula

doc: don't reuse README for index.rst and project home page

The documentation main page and the project home page have slightly
different functions. At the cost of slight duplication, have different
texts for each.

Add README.rst to conf.py excludes as it's only used by gitlab.
Reviewed-by: 's avatarRodrigo Vivi <rodrigo.vivi@intel.com>
Acked-by: Daniel Stone's avatarDaniel Stone <daniels@collabora.com>
Reviewed-by: 's avatarEmil Velikov <emil.velikov@collabora.com>
Signed-off-by: Jani Nikula's avatarJani Nikula <jani.nikula@intel.com>
parent 36a905f7
This documentation covers the tools and workflows for maintaining and
DRM Maintainer Tools
====================
This project covers the tools and documentation for maintaining, committing, and
contributing to the Linux kernel DRM subsystem's drm-misc and drm-intel
repositories. The intended audience is primarily the maintainers and committers
of said repositories, but the workflow documentation may be useful for anyone
interested in the kernel graphics subsystem development.
Both drm-misc and drm-intel are maintained using the same tools and very similar
workflows. Both feed to the same testing and integration tree, the drm-tip. The
documentation here is mostly shared, highlighting the differences in workflows
where applicable.
Please use the `dim-tools@lists.freedesktop.org`_ mailing list for
contributions, bug reports, and discussion about the tooling and documentation.
Please see the `DRM Maintainer Tools Documentation`_ for more information, and
`contributing and contact`_ on how to collaborate on the documentation and
tools.
.. _dim-tools@lists.freedesktop.org: https://lists.freedesktop.org/mailman/listinfo/dim-tools
.. _DRM Maintainer Tools Documentation: https://drm.pages.freedesktop.org/maintainer-tools/
Visit the `DRM Maintainer Tools
Documentation <https://drm.pages.freedesktop.org/maintainer-tools/>`_ for more
information on these tools.
.. _contributing and contact: https://drm.pages.freedesktop.org/maintainer-tools/CONTRIBUTING.html
......@@ -80,7 +80,7 @@ language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'README.rst']
# The reST default role (used for this markup: `text`) to use for all
# documents.
......
DRM Maintainer Tools
====================
.. include:: README.rst
This documentation covers the tools and workflows for maintaining and
contributing to the Linux kernel DRM subsystem's drm-misc and drm-intel
repositories. The intended audience is primarily the maintainers and committers
of said repositories, but the workflow documentation may be useful for anyone
interested in the kernel graphics subsystem development.
Both drm-misc and drm-intel are maintained using the same tools and very similar
workflows. Both feed to the same testing and integration tree, the drm-tip. The
documentation here is mostly shared, highlighting the differences in workflows
where applicable.
Please see :ref:`contributing` as well as the `project home page`_ for more
information on how to collaborate on the documentation and tools.
.. _project home page: https://gitlab.freedesktop.org/drm/maintainer-tools/
Contents:
......
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