NAME

lgt2rst - Logtalk script for converting XML documenting files into reStructuredText files, notably for use with Sphinx

SYNOPSIS

lgt2rst [-d directory] [-i index] [-t title] [-p processor] [-s] [-m]
lgt2rst -h

DESCRIPTION

lgt2rst is a Logtalk script for converting all Logtalk XML documenting files in the current directory into reStructuredText files, notably for use with Sphinx. Assumes UTF-8 encoding.

OPTIONS

-d directory Output directory for the reStructuredText files.

-i index Name of the index file.

-t title Title to be used on the index file.

-p processor XSLT processor.

-s Runs sphinx-quickstart script.

-m Runs make html (requires also using the -s option).

-h Prints a summary of the script options.

REQUIREMENTS

Requires a compatible XSLT processor. See the script help screen for more information. The use of the -s option requires Sphinx, the Read the Docs Sphinx theme, and Pygments to be installed.

ENVIRONMENT

LOGTALKHOME Specifies the location of the Logtalk installation.

LOGTALKUSER Specifies the location of the Logtalk user directory.

FILES

$LOGTALKHOME/tools/lgtdoc/xml/logtalk_entity.dtd The Logtalk entity DTD file.

$LOGTALKHOME/tools/lgtdoc/xml/logtalk_index.dtd The Logtalk index DTD file.

$LOGTALKUSER/tools/lgtdoc/xml/custom.ent The Logtalk custom entities file.

$LOGTALKHOME/tools/lgtdoc/xml/logtalk_entity.xsd The Logtalk entity XML Schema file.

$LOGTALKHOME/tools/lgtdoc/xml/logtalk_index.xsd The Logtalk index XML Schema file.

$LOGTALKUSER/tools/lgtdoc/xml/logtalk_entity_to_rst.xsl The Logtalk entity XSLT file.

$LOGTALKUSER/tools/lgtdoc/xml/logtalk_index_to_rst.xsl The Logtalk index XSLT file.

$LOGTALKUSER/tools/lgtdoc/xml/conf.py_t The conf.py template file.

$LOGTALKUSER/tools/lgtdoc/xml/css/sphinx/custom.css The CSS file used to customize the Sphinx Read the Docs theme.

SEE ALSO

The Sphinx website at https://www.sphinx-doc.org/

The Pygments website at https://pygments.org/

The Read the Docs theme website at https://github.com/readthedocs/sphinx_rtd_theme

The Logtalk website at https://logtalk.org/

The Logtalk User and Reference Manuals at $LOGTALKHOME/manuals/index.html

logtalk_user_setup(1), lgt2html(1), lgt2xml(1), lgt2pdf(1), lgt2md(1), lgt2txt(1)

AUTHOR

Paulo Moura <pmoura@logtalk.org>

COPYRIGHT

Copyright (c) 1998-2021 Paulo Moura.

This HTML page was made with roffit.