This patchset is an effort to fix something up which I promised Markus I would do after we got the initial conversion to Sphinx done. The old QAPI reference documentation noted the documentation license in the texinfo source (but not in the generated HTML or in the generated manpages); Sphinx generated docs currently don't.
The patchset starts with some tidyup that is possible now that we have a single combined HTML manual rather than five separate ones. Rather than putting common-to-all-QEMU info like the deprecation, build and license pages into the "system" manual, we can move them out to a new top level section which I have called "About". So that the manual doesn't now start too abruptly, I've also added some actual "about" text here (mostly cribbed or adapted from our website or from other parts of the manual). Secondly, it uses the Sphinx template-override functionality to add more text to the footer added to each HTML page, which will now read: # © Copyright 2021, The QEMU Project Developers. # # Built with Sphinx using a theme provided by Read the Docs. # # This documentation is for QEMU version 6.0.50. # # QEMU and this manual are released under the GNU General Public License, version 2. where the last line is a hyperlink to the about/license page. I'm open to suggestions on: * name of the new top-level section * text wording * whether we need to have the version number in the footer (it's already in the sidebar under the QEMU logo, but this seemed a bit too inconspicious, so I added it to the footer since I was messing with it anyway) You can find a built version of the docs at: https://pm215.gitlab.io/-/qemu/-/jobs/1399259647/artifacts/public/index.html I had a look at getting our manpages to also state the license, but this is tricky due to various deficiencies in Sphinx. (We never have stated the license in our manpages, so this isn't a regression compared to the old texinfo setup.) Markus: do you feel this series is sufficient that we can remove the TODO lines in docs/interop/qemu-ga-ref.rst, docs/interop/qemu-qmp-ref.rst and docs/interop/qemu-storage-daemon-qmp-ref.rst as now being done? thanks -- PMM Peter Maydell (7): docs: Fix documentation Copyright date docs: Stop calling the top level subsections of our manual 'manuals' docs: Remove "Contents:" lines from top-level subsections docs: Move deprecation, build and license info out of system/ docs: Add some actual About text to about/index.rst docs: Add license note to the HTML page footer docs: Add QEMU version information to HTML footer docs/_templates/footer.html | 14 +++++++++++ docs/{system => about}/build-platforms.rst | 0 docs/{system => about}/deprecated.rst | 0 docs/about/index.rst | 27 +++++++++++++++++++++ docs/{system => about}/license.rst | 0 docs/{system => about}/removed-features.rst | 0 docs/conf.py | 2 +- docs/devel/index.rst | 7 +----- docs/index.rst | 1 + docs/interop/index.rst | 9 ++----- docs/meson.build | 3 ++- docs/specs/index.rst | 7 ++---- docs/system/index.rst | 11 +-------- docs/tools/index.rst | 7 ++---- docs/user/index.rst | 7 +----- MAINTAINERS | 1 + 16 files changed, 55 insertions(+), 41 deletions(-) create mode 100644 docs/_templates/footer.html rename docs/{system => about}/build-platforms.rst (100%) rename docs/{system => about}/deprecated.rst (100%) create mode 100644 docs/about/index.rst rename docs/{system => about}/license.rst (100%) rename docs/{system => about}/removed-features.rst (100%) -- 2.20.1
