Replace the Documentation Makefile with a Shell Script #2601
Conversation
settermjd
changed the title
|
@pmaier1 has requested .docx copies of the manual a few times, so it made sense to codify the functionality here to avoid having to remember it for next time. |
|
@settermjd what are the recommended steps to test-drive this? |
This is a port of the cli script from the docs repository, streamlined for a single-component Antora setup. It also supports exporting the manual to docx format as well.
settermjd
force-pushed
the
migrate-docs-makefile-to-cli-script
branch
from
fbe7957 to
db1f6e7
Compare
|
@pmaier1 please clarify why you need this. Changes to a .docx document will never be put back into the repository. Why do we need that? I don't think that we want to maintain another container which includes the required tools just for fun or if there is no need for it. |
|
@michaelstingl, I've updated the PR description with the relevant information. @tboerger, the docx generation command would only be used locally. |
We needed the export once currently for some people to develop their own documentation based on ours. I don't know about further requirements or similar. At this point I don't find it necessary to automate this. I would rather want to check with those people whether they can also use Antora to create their own/branded docs. |
This comment has been minimized.
This comment has been minimized.
|
The functionality for generating docx versions of the manual have been removed. |
The script was missing the mplus fonts and one of the notoserif font files was incorrectly named. This commit corrects both of these issues.
Honestly, I don't see an advantage one way or another, whether the attributes set on the command line or in the config file. However, the command line approach does provide that much greater level of flexibility, which is the motivation for this commit, originally inspired by tboerger in #2601 (comment).
I never encountered this while developing the script on macOS (using GNU Bash), however, using Bash 4.4.20(1)-release on Linux Mint 19.2, the script doesn't work, because asciidoctor-pdf says that it can't read a FIFO, only a file. Given that, this change is being made to have it run properly on Bash in Linux.
This is perhaps just me being nitpicky, but in certain instances, when the text is full justified, it renders somewhat unprofessionally. Left justified, however, never has this problem, so the change is being made.
|
@tboerger, can I get another review, pls? |
delete-merged-branch
bot
deleted the
migrate-docs-makefile-to-cli-script
branch
Honestly, I don't see an advantage one way or another, whether the attributes set on the command line or in the config file. However, the command line approach does provide that much greater level of flexibility, which is the motivation for this commit, originally inspired by tboerger in #2601 (comment).
Honestly, I don't see an advantage one way or another, whether the attributes set on the command line or in the config file. However, the command line approach does provide that much greater level of flexibility, which is the motivation for this commit, originally inspired by tboerger in #2601 (comment).
This is a port of the cli script from the docs repository, streamlined for a single-component Antora setup. It also supports exporting the manual to docx format as well.
The manual generation can be tested with the following commands: