| Age | Commit message (Collapse) | Author |
|---|
|
We now use docs.yoctoproject.org so update the urls to point there
instead of at a redirect.
grep https://www.yoctoproject.org/docs/ * -lrZ | xargs -0 -l sed -i -e 's#https://www.yoctoproject.org/docs/#https://docs.yoctoproject.org/#g'
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
|
|
For every other docs branch we can run set_versions.py once and have the correct
information in switchers.js. For transitions, we have multiple runs of the
documentation generation and we want to customise switchers.js in each case.
This is so we can show the current version, and the current release series
latest version which allows the switcher to work properly. To do that, it is
easiest just to fix the transitions branch to handle that.
This allows an improved and custmomised switcher for each release showing the
current doc version, the latest in that series and the latest releases for
the project overall.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
|
|
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
|
|
Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
|
|
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
|
|
When the license identifier tags were added, an incorrect string was used
and the Share-Alike clause was lost. Fix this to match the license
description in the files and add back the lost piece (its clear from
the history it should be there)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
|
|
Create a makefile target for each 'release', so that we can call make
with -j<X> to speed up the build.
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
This more closely matches the original docbook style and is appropriate
given the way the manual uses this element.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
|
|
The 'verbatim' text was rendered with Courier font in DocBook
(e.g. when using the <filename> tag). With DocBook we are using the
``FOO`` notation which ends up in a <pre> class in the HTML
output. Configure the theme CSS to use Courier, to preserve the look
and feel of the original docs.
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
When switching back and forth between between regular and mega manual
an extra '/' keeps being added to the URL.
Reported-by: Quentin Schulz <quentin.schulz@streamunlimited.com>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Add support to create a 'transition' page for each Yocto Project
release. For each release we have a page that contains the links for
the released DocBook based documentation files.
How it works:
1. we create a new directive 'docbook-transition', and for
each old release we create an .rst file
(transition/<version>/index.rst), which uses this new include
directive and refer to a 'master' index file.
2. the new directive parses the 'master' index file, and replaces
@VER@ with the right version.
3. in conf.py, we add a hook, which is run at the end of the config,
and if 'srcdir' is transition/*/ which means we are building for a
legacy doc, we override version/release fields.
4. we create a new 'master' index file whenever we add or remove a
documentation file (e.g. whenever the template needs to be updated).
Also in Makefile we add a target ('publish') to generate a "built"
docs tree in a 'final' directory.
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
This branch will host 'transition' pages created during the migration
from DocBook to Sphinx. For each Yocto Project release, we create a
Sphinx page with links to all documents included in the release.
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
Richard Purdie
Michael Opdenacker
Michael Halstead
Nicolas Dechesne