Only one link leads to it and it doesnt (right now) fit into the hierarchy.
Let's get rid of the sphinx warning.
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Switching from doxygen to sphinx broke a bunch of links because doxygen used
whatever the argument to @page was - and that usually had underscores. Sphinx
uses filenames (which use dashes) so now we have a bunch of old links going to
a 404. For the transition period at least, insert a custom 404 page for each
of those to tell users this doesn't exist anymore.
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Things moved around, so let's have a custom 404 page where we can put
information in. This ist the barebones version, not sure if .htaccess is
supported.
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
meson doesn't have configuration_data() in vcs_tag so we can only replace one
string. sphinx cannot include things in-line.
Since we want the git version to be replaced in random places, we need to put
it into rst_prolog in conf.py - but that's where we neet to replace other
things too. Work around this by generating a mini python module that returns
the git version, then call that in conf.py.
Side-bonus: we now have access to the full commit and the abbreviated commit.
Not that anything actually uses this...
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Now that we dropped autotools anyway, it's better to link to the meson version
of that blog post.
Related #96
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Anyone who's still on <= 1.8 either knows how to build it already or relies on
a distribution to do that for them. Drop the section.
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
This is a large commit because it's difficult to split this up and we don't
care about bisecting here anyway.
doxygen is going to produce the API documentation only
sphinx is going to produce the prose user (and a bit of developer) documentation.
The source split is doc/api and doc/user.
Steps performed:
- run the doxygen-to-sphinx.sh script to convert all .dox sources to .rst
- manually fixed the .rst to render correctly
- add a few extra .rst documents to generate the right hierarchy
- hook up sphinx-build in meson
- add a new @mainpage for doxygen more aimed at developers
For the build directory:
- sphinx produces /Documentation
- doxygen now produces /api/
These need to be manually combined in the wayland-web repo, meson doesn't
support subdirectories as output paths within the build dir and the
documentation doesn't need to be installed anywhere.
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
This is mostly for sphinx' parsing benefit, doxygen doesn't need it and
renders the same either way.
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
The vast majority of ppl reading the README is unlikely to care about this,
but they do care about the Wayland vs X.Org situation so let's split this up.
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
This isn't required by doxygen but for a potential switch to RTD/sphinx
(see #95) it helps having this set up correctly.
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Add some documentation for the most common quirks or at least the ones that
the user may eventually see or have to set. Drop the git commit hash into the
docs to make sure it's spelled out that the quirks are only valid for that
commit. Adding something with @include* requires the EXAMPLE_PATH to be set.
Doxygen doesn't parse markdown in @includedoc so we have to insert the commit
as normal HTML tag.
Related to https://gitlab.freedesktop.org/libinput/libinput/issues/87
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
