Merge pull request #1763 from bettio/do-not-publish-pdf-epub

Despite the branch name, we are just discarding PDF build.

These changes are made under both the "Apache 2.0" and the "GNU Lesser General
Public License 2.1 or later" license terms (dual license).

SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later

Author: bettio

doc/CMakeLists.txt

@@ -132,8 +132,6 @@ if(SPHINX_FOUND)
     message("Doxygen found: ${DOXYGEN_BUILD_EXECUTABLE}")
     message("Sphinx found: ${SPHINX_BUILD_EXECUTABLE}")
     configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
-    file(COPY ${CMAKE_CURRENT_SOURCE_DIR}/pdf_stylesheet.rts DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/)
-    file(COPY ${CMAKE_CURRENT_SOURCE_DIR}/pdf_template.rtt DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/)
     file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html/apidocs/libatomvm)
     add_custom_target(sphinx-html
         ${SPHINX_BUILD_EXECUTABLE} -q --doctree-dir ${CMAKE_CURRENT_BINARY_DIR}/doctree -b html -c ${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_BINARY_DIR}/src/ ${CMAKE_CURRENT_BINARY_DIR}/html/
@@ -142,13 +140,6 @@ if(SPHINX_FOUND)
         DEPENDS ${DOTFILE_TARGETS} ${ERLANG_EDOC_TARGETS}
     )
 
-    add_custom_target(sphinx-pdf
-        ${SPHINX_BUILD_EXECUTABLE} -q --doctree-dir ${CMAKE_CURRENT_BINARY_DIR}/doctree -D exclude_patterns=apidocs/libatomvm/** -b rinoh -c ${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_BINARY_DIR}/src/ ${CMAKE_CURRENT_BINARY_DIR}/pdf/
-        WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
-        COMMENT "Generating Sphinx PDF documentation" VERBATIM
-        DEPENDS ${DOTFILE_TARGETS} ${ERLANG_EDOC_TARGETS}
-    )
-
     add_custom_target(sphinx-epub
         ${SPHINX_BUILD_EXECUTABLE} -q --doctree-dir ${CMAKE_CURRENT_BINARY_DIR}/doctree -D exclude_patterns=apidocs/libatomvm/**,LICENSES/** -b epub -c ${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_BINARY_DIR}/src/ ${CMAKE_CURRENT_BINARY_DIR}/epub/
         WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
@@ -186,7 +177,7 @@ foreach(LIBAVM_ERL_LIB ${ERLANG_LIBS})
 endforeach(LIBAVM_ERL_LIB)
 
 add_custom_target(doc #ALL
-    DEPENDS sphinx-html sphinx-pdf sphinx-epub
+    DEPENDS sphinx-html sphinx-epub
 )
 
 if (TARGET GitHub_CI_Publish_Docs)
@@ -198,14 +189,6 @@ if (TARGET GitHub_CI_Publish_Docs)
         COMMENT "Prepare publish directory structure." VERBATIM
     )
 
-    file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html/pdf)
-    add_custom_command(TARGET sphinx-pdf POST_BUILD
-        COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_BINARY_DIR}/pdf/AtomVM-${DOC_TREE_VERSION}.pdf ${CMAKE_CURRENT_BINARY_DIR}/html/pdf/
-        WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/pdf
-        COMMENT "Copying pdf to download location" VERBATIM
-        DEPENDS $ENV{DOC_TREE_VERSION}
-    )
-
     file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html/epub)
     add_custom_command(TARGET sphinx-epub POST_BUILD
         COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_BINARY_DIR}/epub/AtomVM-${DOC_TREE_VERSION}.epub ${CMAKE_CURRENT_BINARY_DIR}/html/epub/

doc/README.md

@@ -16,7 +16,6 @@ AtomVM documentation is built using the following tools:
 Dependencies and make files are generated via the standard CMake tooling used in AtomVM builds.  However, the documentation sets are not built by default.  Instead, issue the following make targets after a CMake
 
 * `make sphinx-html` to build the Sphinx HTML documentation (includes libAtomVM 'C' and Erlang APIs)
-* `make sphinx-pdf` to build the Sphinx PDF documentation, (includes Erlang APIs)
 * `make sphinx-epub` to build the Sphinx ePUB documentation, (includes Erlang APIs)
 * `make doc` to build all of the above
 
@@ -41,10 +40,6 @@ To build documentation using Sphinx, we recommend using a Python virtual environ
     (sphinx) shell$ python3 -m pip install pygments
 
 
-    ## needed for PDF
-    (sphinx) shell$ python3 -m pip install rinohtype
-    (sphinx) shell$ python3 -m pip install pillow
-
 There is also a reqirements.txt to simplify installing all of the dependencies at once.
 
     shell$ python3 -m venv $HOME/python-env/sphinx

doc/conf.py.in

@@ -222,20 +222,8 @@ html_sidebars = {
 
 # POPULATE LINKS TO OTHER FORMATS/DOWNLOADS
 html_context['downloads'] = list()
-html_context['downloads'].append( ('pdf', '/' +download_version+ '/pdf/' +project+ '-' +download_version+ '.pdf') )
 html_context['downloads'].append( ('epub', '/' +download_version+ '/epub/' +project+ '-' +download_version+ '.epub') )
 
-# -- Options for PDF output -------------------------------------------------
-
-rinoh_documents = [dict(
-  doc=master_doc,
-  target=project+ '-' +download_version,
-  logo='@CMAKE_CURRENT_SOURCE_DIR@/src/_static/AtomVM-logo.png',
-  template='pdf_template.rtt'
-)]
-
-today_fmt = "%B %d, %Y"
-
 # -- Options for EPUB output -------------------------------------------------
 
 epub_tocdepth = 3

doc/pdf_stylesheet.rts

@@ -10,5 +10,3 @@ sphinx-rtd-theme
 gitpython
 breathe
 pygments
-rinohtype
-pillow