gbdk-2020 | GameBoy Development Kit |
| download: https://git.y1.nz/archives/gbdk.tar.gz | |
| README | Files | Log | Refs | LICENSE |
commit f264f43ec420168736fb24481c9c1587db2b3886 parent 1e5415eb07777cfac8e8f8720937b0f26c6dc7b1 Author: Toxa <56631470+untoxa@users.noreply.github.com> Date: Mon, 22 Mar 2021 00:39:33 +0300 Merge pull request #155 from bbbbbr/docs_pdf Add support for PDF documentation Diffstat:
13 files changed, 23 insertions(+), 5 deletions(-)
diff --git a/Makefile b/Makefile @@ -56,9 +56,8 @@ clean: gbdk-support-clean gbdk-lib-clean distclean: clean build-dir-clean docs: doxygen-generate - +docspdf: doxygen-generate-with-pdf docsclean: doxygen-clean - docsreset: doxygen-reset # Build rule for michaelh's machine to spin a release @@ -135,6 +134,7 @@ gbdk-support-install: gbdk-support-build $(BUILDDIR)/bin @$(TARGETSTRIP) $(BUILDDIR)/bin/lcc* @cp $(GBDKSUPPORTDIR)/ChangeLog $(BUILDDIR) @cp $(GBDKSUPPORTDIR)/README $(BUILDDIR) + @cp $(GBDKDOCSDIR)/gbdk_manual.pdf $(BUILDDIR) @echo @echo Installing ihxcheck @cp $(GBDKSUPPORTDIR)/ihxcheck/ihxcheck $(BUILDDIR)/bin/ihxcheck$(EXEEXTENSION) @@ -251,6 +251,24 @@ endif rm -rf $(GBDKDOCSDIR)/api; \ cd "$(GBDKLIBDIR)/include"; \ GBDKDOCSDIR="$(GBDKDOCSDIR)" GBDKLIBDIR="$(GBDKLIBDIR)" $(DOXYGENCMD) "$(GBDKDOCSDIR)/config/gbdk-2020-doxyfile" + @if [ "$(DOCS_PDF_ON)" = "YES" ]; then\ + $(MAKE) -C $(GBDKDOCSDIR)/latex;\ + cp $(GBDKDOCSDIR)/latex/refman.pdf $(GBDKDOCSDIR)/gbdk_manual.pdf;\ + fi + rm -rf $(GBDKDOCSDIR)/latex + +# Turn on Latex -> PDF conversion to run run at end of regular docs build +# (which includes latex output but deletes it at the end). +# +# The conversion process requires a Latex install. +# For Windows there are various Latex packages to choose from. +# For Linux this appears to be the minimum: +# sudo apt install texlive-latex-base +# sudo apt install texlive-latex-recommended +# sudo apt install texlive-latex-extra +# +doxygen-generate-with-pdf: DOCS_PDF_ON=YES +doxygen-generate-with-pdf: doxygen-generate doxygen-clean: rm -rf $(GBDKDOCSDIR)/api diff --git a/docs/config/gbdk-2020-doxyfile b/docs/config/gbdk-2020-doxyfile @@ -1707,7 +1707,7 @@ EXTRA_SEARCH_MAPPINGS = # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. # The default value is: YES. -GENERATE_LATEX = NO +GENERATE_LATEX = YES # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of @@ -1755,7 +1755,7 @@ LATEX_MAKEINDEX_CMD = makeindex # The default value is: NO. # This tag requires that the tag GENERATE_LATEX is set to YES. -COMPACT_LATEX = NO +COMPACT_LATEX = YES # The PAPER_TYPE tag can be used to set the paper type that is used by the # printer. @@ -1881,7 +1881,7 @@ LATEX_BIB_STYLE = plain # The default value is: NO. # This tag requires that the tag GENERATE_LATEX is set to YES. -LATEX_TIMESTAMP = NO +LATEX_TIMESTAMP = YES # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) # path from which the emoji images will be read. If a relative path is entered, diff --git a/docs/gbdk_manual.pdf b/docs/gbdk_manual.pdf Binary files differ. diff --git a/docs/pages/getting_started.md b/docs/pages/01_getting_started.md diff --git a/docs/pages/links_and_tools.md b/docs/pages/02_links_and_tools.md diff --git a/docs/pages/using_gbdk.md b/docs/pages/03_using_gbdk.md diff --git a/docs/pages/coding_guidelines.md b/docs/pages/04_coding_guidelines.md diff --git a/docs/pages/banking_mbcs.md b/docs/pages/05_banking_mbcs.md diff --git a/docs/pages/toolchain.md b/docs/pages/06_toolchain.md diff --git a/docs/pages/sample_programs.md b/docs/pages/07_sample_programs.md diff --git a/docs/pages/faq.md b/docs/pages/08_faq.md diff --git a/docs/pages/migrating_new_versions.md b/docs/pages/09_migrating_new_versions.md diff --git a/docs/pages/release_notes.md b/docs/pages/10_release_notes.md
This webpage is intended to be an accessible preview of this repository. To get a fuller picture, clone it and use the git CLI.