All of lore.kernel.org
 help / color / mirror / Atom feed
* [RFC 0/3] add support for diagrams generated from SVG sources
@ 2021-05-15  7:12 Michael Opdenacker
  2021-05-15  7:12 ` [RFC 1/3] Makefile: allow epub and latexpdf outputs to use diagrams " Michael Opdenacker
                   ` (3 more replies)
  0 siblings, 4 replies; 14+ messages in thread
From: Michael Opdenacker @ 2021-05-15  7:12 UTC (permalink / raw)
  To: docs; +Cc: Michael Opdenacker

This RFC proposes modifications to the Makefile and the Sphinx
configuration (conf.py file) to support:

- The generation of PNG diagrams from SVG sources for the generation
  of the EPUB manual. Directly using SVG in EPUB shows at least
  font size and alignment issues.

  The conf.py file has been modified to let the EPUB builder know
  that it should prefer PNG over SVG when both formats are available.

- The generation of PDF diagrams from SVG sources for the generation
  of the PDF manual. PDF output cannot use SVG, and needs PDF diagrams
  instead.

New diagrams are stored in separate "svg" directories so that generated
.png and .pdf files can be "gitignored" without ignoring the original
.png files that have no .svg source.

In the source .rst files, new diagrams can now be included as, for example:
image:: svg/git-workflow.*

Note that the way the Makefile was modified can most probably be improved,
as my "make" skills are pretty limited. I'm interested in your suggestions!

My goal is to progressively replace PNG diagrams with SVG ones:
   - To get high quality definition output documents, in all output formats
   - To Have the ability to update diagrams
I would indeed do this very progressively, a little bit every week,
not at the expense of other tasks.

Michael Opdenacker (3):
  Makefile: allow epub and latexpdf outputs to use diagrams from SVG
    sources
  conf.py: prefer PNG to SVG in EPUB output
  overview-manual: SVG diagram for the git workflow

 documentation/.gitignore                      |    2 +
 documentation/Makefile                        |   29 +-
 documentation/conf.py                         |    4 +
 .../development-environment.rst               |    4 +-
 .../overview-manual/figures/git-workflow.png  |  Bin 26586 -> 0 bytes
 .../overview-manual/svg/git-workflow.svg      | 1205 +++++++++++++++++
 6 files changed, 1239 insertions(+), 5 deletions(-)
 delete mode 100644 documentation/overview-manual/figures/git-workflow.png
 create mode 100644 documentation/overview-manual/svg/git-workflow.svg

-- 
2.25.1


^ permalink raw reply	[flat|nested] 14+ messages in thread

end of thread, other threads:[~2021-05-28 15:19 UTC | newest]

Thread overview: 14+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-05-15  7:12 [RFC 0/3] add support for diagrams generated from SVG sources Michael Opdenacker
2021-05-15  7:12 ` [RFC 1/3] Makefile: allow epub and latexpdf outputs to use diagrams " Michael Opdenacker
2021-05-16 22:12   ` [docs] " Nicolas Dechesne
2021-05-17  8:50     ` Michael Opdenacker
2021-05-17 12:26       ` Nicolas Dechesne
2021-05-28 14:40   ` Quentin Schulz
2021-05-28 15:19     ` Michael Opdenacker
2021-05-15  7:12 ` [RFC 2/3] conf.py: prefer PNG to SVG in EPUB output Michael Opdenacker
2021-05-16 22:29   ` [docs] " Nicolas Dechesne
2021-05-17  8:36     ` Michael Opdenacker
2021-05-15  7:12 ` [RFC 3/3] overview-manual: SVG diagram for the git workflow Michael Opdenacker
2021-05-16 22:11 ` [docs] [RFC 0/3] add support for diagrams generated from SVG sources Nicolas Dechesne
2021-05-17  8:45   ` Michael Opdenacker
2021-05-17 12:33     ` Nicolas Dechesne

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.