Skip to content

Latest commit

 

History

History
 
 

README.md

pdf2docx documentation

Welcome to the pdf2docx documentation. This documentation relies on Sphinx to publish HTML docs from markdown files written with restructured text (RST).

Sphinx version

This README assumes you have Sphinx v5.0.2 installed on your system.

Updating the documentation

Within docs update the associated restructured text (.rst) files. These files represent the corresponding document pages.

Building HTML documentation

  • Ensure you have the furo theme installed:

pip install furo

Furo theme, Copyright (c) 2020 Pradyun Gedam mail@pradyunsg.me, thank you to:

https://github.com/pradyunsg/furo/blob/main/LICENSE

  • From the "docs" location run:

sphinx-build -b html . build/html

This then creates the HTML documentation within build/html.

Use: sphinx-build -a -b html . build/html to build all, including the assets in _static (important if you have updated CSS).

For full details see: Using Sphinx