pydocmaker
  • Installation
  • Install Optional Requirements
    • Optional Requirement pandoc
    • Optional Requirement Latex
    • Optional Requirement for DOCX either libreoffice or win32com
      • Installing pywin32 (Windows only)
      • Installing libreoffice
  • TL;DR; Example
  • Configuring Options:
  • Examples
    • Getting Started Examples
      • Most minimal example
      • Writing a small pydoc
      • “Showing” Documents in iPython/Terminal
      • Exporting pydocs to common formats
        • Exporting to PDFs (via typst, pandoc, LaTeX, Word, or Libreoffice)
      • Add pyplot Figures to your pydoc
      • Add an image from a numpy array
      • pydoc to python list
      • Storing metadata
      • Adding a table
      • Configuring/testing PDF engines
    • Writing docx Documents
      • To docx (no template, no dependencies)
      • Prepare a template and fields (optional)
      • To docx (no additional dependencies)
      • To docx via Word (with additional dependencies)
      • To PDF via docx with Word (with additional dependencies)
      • To PDF via docx with Libreoffice (with additional dependencies)
      • The hard way: using the low level classes and functions
    • Using templates (HTML, Typst, and LaTeX)
      • The pydocmaker inbuild templates
      • Definition of templates
      • Adding / defining you own template
      • Inspecting parameters
      • Using your template
      • Jinja2 templates from strings
      • A note on engine(s) and templates when using to_pdf
        • Automatically determine engine if engine=None
        • Directly stating engine and template
    • Export reports to Redmine wiki
      • Build example document to upload
      • Define the connection to our Redmine server
      • The easy way: upload via .upload_report_to_redmine(...)
      • The harder way: export and manual upload
    • Detailed Usage Instructions
      • Doc the Document builder
      • Document part schemas
      • Adding document parts to a doc
      • Working with images
      • Adding parts to specific chapters
      • Using the low level constr constructor factory
    • Library Configuration
      • Renderer Configuration
        • Getting the current renderer
        • Changing the renderer
      • PDF Engine Configuration
        • Getting the current PDF engine
        • Scanning for available engines
        • Setting the PDF engine explicitly
        • Testing engine availability
      • LaTeX Compiler Configuration
        • Getting the current compiler
        • Scanning for available compilers
        • Setting the compiler explicitly
      • LibreOffice Path Configuration
        • Finding the LibreOffice path
        • Getting the current path
        • Setting a custom path
      • Convenience Functions
        • pyd.options class
        • pyd.info_optionals()
      • Working Example
      • Pandoc Configuration
  • Data Model
    • Element Properties
    • Supported Types
    • JSON Definition

API-Reference

  • API Reference
    • pydocmaker
      • Submodules
        • pydocmaker.b64_data
        • pydocmaker.backend
        • pydocmaker.core
        • pydocmaker.templating
        • pydocmaker.util
      • Attributes
      • Classes
      • Functions
      • Package Contents
        • __version__
        • Doc
        • construct()
        • constr
        • buildingblocks
        • print_to_pdf()
        • make_pdf_from_tex()
        • show_pdf()
        • is_notebook()
        • upload_report_to_redmine()
        • bcolors
        • txtcolor()
        • colors_dc
        • _raise_missing
        • log
        • remove_undefined()
        • DocxFile
        • DocxFileW32
        • can_use_libreoffice()
        • can_use_w32_word()
        • pandoc_convert_file()
        • pandoc_set_allowed()
        • pandoc_convert()
        • config_pandoc_allowed_set
        • config_pandoc_allowed_get
        • DocTemplate
        • TemplateDirSource
        • register_new_template_dir()
        • get_registered_template_dirs()
        • get_available_template_ids()
        • test_template_exists()
        • remove_from_template_dir()
        • get_template_params()
        • resolve_template_id()
        • tex_escape
        • config_libreoffice_path_get()
        • config_libreoffice_path_set()
        • config_libreoffice_path_find()
        • config_libreoffice_path_testset()
        • config_pdf_engine_get()
        • config_pdf_engine_set()
        • config_pdf_engine_scan()
        • config_pdf_engine_test()
        • config_renderer_default_get()
        • config_renderer_default_set()
        • test_typst_installed()
        • compile_with_typst()
        • config_latex_compiler_scan()
        • config_latex_compiler_get()
        • config_latex_compiler_set()
        • config_latex_compiler_testset()
        • info_optionals()
        • options
        • pandoc_set_enabled()
        • pandoc_set_disabled()
        • get_schema()
        • get_example()
        • load()
        • md2tex()
        • mk_chapter()
        • mk_meta()
        • mk_tex()
        • mk_md()
        • mk_pre()
        • mk_fig()
        • mk_image()
pydocmaker
  • API Reference
  • View page source

API Reference

This page contains auto-generated API reference documentation [1].

  • pydocmaker
    • pydocmaker.b64_data
    • pydocmaker.backend
      • pydocmaker.backend.baseformatter
      • pydocmaker.backend.ex_docx
      • pydocmaker.backend.ex_html
      • pydocmaker.backend.ex_ipynb
      • pydocmaker.backend.ex_markdown
      • pydocmaker.backend.ex_redmine
      • pydocmaker.backend.ex_rich
      • pydocmaker.backend.ex_tex
      • pydocmaker.backend.ex_typst
      • pydocmaker.backend.libreoffice_api
      • pydocmaker.backend.mdx_latex
      • pydocmaker.backend.pandoc_api
      • pydocmaker.backend.pdf_maker_tex
    • pydocmaker.core
    • pydocmaker.templating
    • pydocmaker.util
[1]

Created with sphinx-autoapi

Previous Next

© Copyright 2025, Tobias Glaubach.

Built with Sphinx using a theme provided by Read the Docs.