Project

General

Profile

Bug #2692

docs should not have unused files

Added by Mark Abraham 12 months ago. Updated 11 months ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
documentation
Target version:
Affected version - extra info:
Affected version:
Difficulty:
uncategorized
Close

Description

reference-manual-minimal and user-guide-old should not exist any more. Are there are other remaining things left behind from the migration to sphinx?

Associated revisions

Revision bd65de70 (diff)
Added by Paul Bauer 11 months ago

Remove unused files in docs/manual

Refs #2692

Change-Id: Ib9f0a7079397cb638bc2d7f67b9d450c004a612e

Revision aaa9dd89 (diff)
Added by Paul Bauer 11 months ago

Change doc build without image conversion

Changed logic to use selective inclusion so that the manual gets build
without pages with images when images cannot be converted.

Cherry picked from master.

Refs #2692

Change-Id: Id112b2b8f20eb5de3b704bc2b27ab7ce55f035ff

History

#1 Updated by Mark Abraham 12 months ago

Also manual/original-conversion-friendly

#2 Updated by Paul Bauer 11 months ago

The reference-manual-minimal and user-guide-old files are kind of needed, because they are used when the image conversion (and thus build) fail for the reference manual and the webpage build falls back to build a minimal version without it.
The conversion-friendly folder should go, though (I even forgot it was still there).

#3 Updated by Gerrit Code Review Bot 11 months ago

Gerrit received a related patchset '1' for Issue #2692.
Uploader: Paul Bauer ()
Change-Id: gromacs~master~Ib9f0a7079397cb638bc2d7f67b9d450c004a612e
Gerrit URL: https://gerrit.gromacs.org/8568

#4 Updated by Mark Abraham 11 months ago

OK. "old" doesn't really help people in three years know what it is for. Naming things for what they are now helps, because that should still be true later on :-)

How about naming things

user-guide/index-without-images.rst
user-guide/flow-without-images.rst
reference-manual/index-without-images.rst

and a comment in the first two .rst files that explains why they are crippled. If they're off in another directory, and not built in Jenkins, the build is sure to rot. In the same directory, they might get noticed and remembered.

#5 Updated by Gerrit Code Review Bot 11 months ago

Gerrit received a related patchset '1' for Issue #2692.
Uploader: Paul Bauer ()
Change-Id: gromacs~master~Id112b2b8f20eb5de3b704bc2b27ab7ce55f035ff
Gerrit URL: https://gerrit.gromacs.org/8575

#6 Updated by Gerrit Code Review Bot 11 months ago

Gerrit received a related patchset '1' for Issue #2692.
Uploader: Paul Bauer ()
Change-Id: gromacs~master~Ifab77b3d7d3b65c39cd447b515931a07b3f72ddc
Gerrit URL: https://gerrit.gromacs.org/8579

#7 Updated by Gerrit Code Review Bot 11 months ago

Gerrit received a related patchset '1' for Issue #2692.
Uploader: Paul Bauer ()
Change-Id: gromacs~release-2019~Id112b2b8f20eb5de3b704bc2b27ab7ce55f035ff
Gerrit URL: https://gerrit.gromacs.org/8589

#8 Updated by Paul Bauer 11 months ago

  • Status changed from New to Closed

Should be fixed now.

Also available in: Atom PDF