Skip to content

readthedocs website + pdfs generated from markdown in NSIS#546

Open
mcarans wants to merge 58 commits intoOoliteProject:masterfrom
mcarans:readthedocs
Open

readthedocs website + pdfs generated from markdown in NSIS#546
mcarans wants to merge 58 commits intoOoliteProject:masterfrom
mcarans:readthedocs

Conversation

@mcarans
Copy link
Contributor

@mcarans mcarans commented Jan 30, 2026

  • Readthedocs website https://oolite.readthedocs.io/en/latest/
  • Major simplification of build_all workflow to remove DOxygen generation, pdf generation and website generation
  • Readthedocs website hosts pdfs as well as markdown and DOxygen
  • OoliteReadMe.pdf is generated from Documentation/docs/index.md and AdviceForNewCommanders.pdf from Documentation/docs/advice.md by the readthedocs build process
  • Reference sheet still comes from the last remaining odt in docs as its layout is not suitable for md - the readthedocs process generates the pdf and hosts it.
  • pdfs are downloaded from readthedocs website when building nsis
  • New pdfs added to nsis - License.pdf and Privacy.pdf
  • Make error messages consistent in existing shell scripts
  • Move much of GNUmakefile.postamble into a shell script

This can be merged for 1.92 or for later if preferred. Once merged I'll edit the readthedocs config in the UI to point to the Oolite repo master branch instead of my fork's readthedocs branch.

@AnotherCommander
Copy link
Member

Due to the number of files this PR touches and the quite radical changes it proposes, I think it would be best to merge it after 1.92 so that we won't have to modify a working release pipeline just before release.

@mcarans
Copy link
Contributor Author

mcarans commented Jan 31, 2026

I also moved most of the GNUmakefile.postamble logic into a bash file. I tested building and running on Windows legacy and modern as well as Linux.

@mcarans
Copy link
Contributor Author

mcarans commented Feb 5, 2026

@AnotherCommander I've brought this PR up to date with master changes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants