Commit 21a46914 authored by Jeremy Cline's avatar Jeremy Cline Committed by Jeremy Cline

Add a Sphinx project

This introduces a Sphinx documentation project and associated CI job. It
includes a minimal index page which will be expanded as individual pages
are added to the project.

The plan is to use the current wiki as a source for this new
documentation project and convert or rewrite things page-by-page. At
some point in the future we can set up redirects or otherwise point
folks who arrive at the old wiki pages to equivalent pages (or the home
page if no equivalent exists in the new documentation) and switch over.

These files, except for the index page, were auto-generated with
sphinx-quickstart.
Signed-off-by: Jeremy Cline's avatarJeremy Cline <jcline@redhat.com>
parent c6f53917
Pipeline #210591 passed with stages
in 1 minute
sources/.ikiwiki/
public/
docs/_build/
docs-venv/
......@@ -28,3 +28,21 @@ pages:
- public
only:
- master
sphinx_docs:
image: "python:3-slim"
stage: test
before_script:
- python3 -m venv docs-venv
- source docs-venv/bin/activate
- pip install "sphinx<4" sphinx-sitemap
script: cd docs && sphinx-build -M html . _build -W
artifacts:
paths: ['docs/_build/html/']
expose_as: "Sphinx HTML Documentation"
only:
refs:
- merge_requests
- master
changes:
- docs/**/*
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
This diff is collapsed.
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:cc="http://creativecommons.org/ns#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
version="1.1"
x="0px"
y="0px"
width="1191px"
height="1191px"
viewBox="-237.382 -193.068 1191 1191"
overflow="visible"
enable-background="new -237.382 -193.068 1191 1191"
xml:space="preserve"
id="svg114"
sodipodi:docname="logo.svg"
inkscape:version="1.0.1 (3bc2e813f5, 2020-09-07)"><metadata
id="metadata118"><rdf:RDF><cc:Work
rdf:about=""><dc:format>image/svg+xml</dc:format><dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" /><dc:title></dc:title><cc:license
rdf:resource="http://creativecommons.org/licenses/by/4.0/" /><dc:creator><cc:Agent><dc:title>Valeria Aguilera</dc:title></cc:Agent></dc:creator><dc:rights><cc:Agent><dc:title>CC BY 4.0</dc:title></cc:Agent></dc:rights></cc:Work><cc:License
rdf:about="http://creativecommons.org/licenses/by/4.0/"><cc:permits
rdf:resource="http://creativecommons.org/ns#Reproduction" /><cc:permits
rdf:resource="http://creativecommons.org/ns#Distribution" /><cc:requires
rdf:resource="http://creativecommons.org/ns#Notice" /><cc:requires
rdf:resource="http://creativecommons.org/ns#Attribution" /><cc:permits
rdf:resource="http://creativecommons.org/ns#DerivativeWorks" /></cc:License></rdf:RDF></metadata><sodipodi:namedview
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1"
objecttolerance="10"
gridtolerance="10"
guidetolerance="10"
inkscape:pageopacity="0"
inkscape:pageshadow="2"
inkscape:window-width="3072"
inkscape:window-height="1664"
id="namedview116"
showgrid="false"
inkscape:zoom="0.79093199"
inkscape:cx="595.5"
inkscape:cy="595.5"
inkscape:window-x="0"
inkscape:window-y="0"
inkscape:window-maximized="1"
inkscape:current-layer="svg114" />
<defs
id="defs100">
</defs>
<path
fill="#59761B"
d="M687.523,198.286c0.193,0,0.388,0,0.58,0c0,132.192,0,264.382,0,396.571 c-6.948,4.5-14.117,8.666-21.32,12.793c-107.541,61.631-214.831,124.629-322.725,186.27c0-132.385,0-264.771,0-397.154 C458.64,330.722,573.164,264.559,687.523,198.286z"
id="path102" />
<path
fill="#89B21F"
d="M344.175,25.004c0-8.167-0.161-18.054,0.192-25.004c85.962,49.587,171.981,99.074,257.984,148.86 c21.471,12.429,42.978,24.729,64.545,37.215c7.078,4.097,14.303,8.069,21.129,12.599 C573.259,264.352,458.633,331.23,344.175,396.572"
id="path104" />
<path
fill="#F6F6F6"
d="M0.208,197.883c0.129,0,0.26,0,0.389,0c116.624,67.558,231.117,133.75,343.464,198.479 c0,132.386,0,264.771,0,397.154c-57.572-32.898-114.868-66.172-172.313-99.238c-50.155-28.869-100.09-58.77-150.412-87.029 c-7.234-4.062-14.35-8.34-21.32-12.793C-0.027,462.158,0.015,329.945,0.208,197.883z"
id="path106" />
<path
fill="#89B21F"
d="M359.427,208.944c-6.728-1.601-13.015-4.207-19.534-4.628c-16.676-1.079-34.808,9.497-38.378,20.5 c-4.044,15.438-0.182,57.896-6.19,75.968c-0.392,2.026-33.646,56.217-42.709,69.94c-8.707,13.181-15.612,28.092-22.902,43.409 c-6.776,21.014-12.036,39.561-15.476,63.309c11.197-2.846,22.854-28.574,23.934-29.859s1.714-4.312,11.969-15.961 c10.254-11.652,15.708,11.762,14.236,23.514c-1.261,10.072-7.657,46.025-5.739,67.5c0.894,10.006,10.045,25.799,17.951,40.986 c2.969,5.703,1.958,10.812,0.584,23.295c-13.536,5.447-14.928,9.604-20.842,12.92c-30.124,0-57.249,0-87.374,0 c0-155.354,0-465.57,0-465.57s59.856-0.217,91.087,0.111c0.288,16.629,3.146,50.141,3.096,50.646 c-0.044,0.436,43.275-37.9,96.282-48.541"
id="path108" />
<path
fill="#FFFFFF"
d="M359.42,136.482c8.533-1.713,17.318-2.708,26.216-2.708c81.975,0,165.751,61.445,172.143,147.717 c0,56.272,0,112.545,0,168.818c-0.97,49.301-1.015,99.502-1.237,149.525c-34.044,0-102.133-0.4-102.133-0.604 c-6.771-7.986-22.764-9.834-35.904-9.645c-5.899-1.893-6.854-8.598-6.81-16.279c2.521-4.982,7.187-6.615,10.525-10.25 c26.243-28.564,14.787-121.162,14.236-130.836c-0.553-9.672,14.816-1.525,19.807,6.633c2.964,4.844,5.827,9.969,7.43,13.867 c5.54,13.494,7.071,29.844,14.854,37.383c3.928-31.361-0.372-67.805-10.522-91.645c-8.812-20.706-25.28-38.195-37.758-56.677 c-13.171-19.508-31.243-34.269-43.331-51.249c-7.674-10.781-13.354-29.705-6.188-44.014c2.529-5.051,7.996-10.982,12.379-15.072 c10.646-9.937,26.479-15.023,35.903-24.72c-19.713,2.224-42.051,6.721-65.614,3.014c-1.351-0.212-2.677-0.485-3.987-0.797 l-15.368-4.083v-64.484"
id="path110" />
<polyline
fill="#89B21F"
points="151.62,599.834 169.957,599.834 169.957,134.265 151.62,134.265 "
id="polyline112" />
</svg>
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
# -- Project information -----------------------------------------------------
project = "Nouveau"
copyright = (
"2020, The Nouveau Project. "
"Logo by Valeria Aguilera under the <a href=https://creativecommons.org/licenses/by/4.0/>CC BY 4.0</a>"
)
author = "The Nouveau Project, Valeria Aguilera"
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
"sphinx.ext.intersphinx",
"sphinx_sitemap",
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "alabaster"
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
html_theme_options = {
"logo": "images/logo.svg",
"logo_name": False,
"page_width": "1040px",
"show_related": True,
"sidebar_collapse": True,
}
# The URL which points to the root of the HTML documentation. It is used to
# indicate the location of document like canonical_url.
html_baseurl = "https://nouveau.freedesktop.org/docs/"
html_favicon = "_static/images/logo.svg"
# A list of paths that contain extra files not directly related to the
# documentation, such as robots.txt or .htaccess. Relative paths are taken as
# relative to the configuration directory. They are copied to the output
# directory. They will overwrite any existing file of the same name.
# As these files are not meant to be built, they are automatically excluded
# from source files.
html_extra_path = ["robots.txt"]
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself. Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
html_sidebars = {
"**": [
"about.html",
"navigation.html",
"relations.html",
"searchbox.html",
"donate.html",
]
}
=======
Nouveau
=======
The **nouveau** project aims to build high-quality, free/libre software drivers
for NVIDIA cards. "Nouveau" [nuvo] is the French word for "new". Nouveau is
composed of a Linux kernel KMS driver (nouveau), Gallium3D drivers in Mesa, and
the Xorg DDX (xf86-video-nouveau). The kernel components have also been ported
to NetBSD.
Community
=========
The nouveau community is present on mailing lists and IRC. The `nouveau mailing
list`_ is for general nouveau discussions. For developers, there is also
nouveau-related discussions on the `dri-devel mailing list`_ and the `mesa-dev
mailing list`_.
The ``#nouveau`` IRC channel on `FreeNode`_ is also available for nouveau
discussion and `logs`_ are available.
The `issue tracker`_ and `this documentation`_ is available on the
`freedesktop.org GitLab`_.
.. _FreeNode: https://freenode.net/
.. _logs: https://people.freedesktop.org/~cbrill/dri-log/index.php?channel=nouveau
.. _nouveau mailing list: https://lists.freedesktop.org/mailman/listinfo/nouveau
.. _dri-devel mailing list: https://lists.freedesktop.org/mailman/listinfo/dri-devel
.. _mesa-dev mailing list: https://lists.freedesktop.org/mailman/listinfo/mesa-dev
.. _issue tracker: https://gitlab.freedesktop.org/drm/nouveau/-/issues
.. _this documentation: https://gitlab.freedesktop.org/nouveau/wiki
.. _freedesktop.org GitLab: https://gitlab.freedesktop.org/nouveau
User-agent: *
Sitemap: https://nouveau.freedesktop.org/docs/sitemap.xml
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