From 67573a5d388f6010749bdd78d8eaf5509a2ae53e Mon Sep 17 00:00:00 2001 From: Kathy Pippert Date: Tue, 15 Feb 2022 11:08:16 -0500 Subject: [PATCH] doc/Enhance PDF generation section and README --- README.rst | 18 +++++++++++------- doc/source/guidelines/doc_practices.rst | 5 +++++ 2 files changed, 16 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 9d6635747..d2f77c277 100644 --- a/README.rst +++ b/README.rst @@ -2,15 +2,19 @@ PyAnsys Developer's Guide ######################### -This guide serves as the central document for: +The *PyAnsys Developer's Guide* is the central document for: -- Ansys developers who want to create and "own" libraries +- Ansys developers who want to create and "own" PyAnsys libraries - Anyone in the Python community who wants to contribute to a - library + PyAnsys library - Anyone who is interested in learning more about the PyAnsys - project and libraries + project and PyAnsys libraries -Web-based documentation can be found in `PyAnsys Developer's Guide `_. +A link to the web-based version of this `guide `_ +is available in the 'About' area for the `dev-guide `_ +repository. A link to a PDF version of this guide is available in the `Releases +`_ section under 'Assets'. -A PDF version of this guide can be found in the release notes in `Releases -`_. +This guide provides an overview that describes the PyAnsys project organization, +project administration, and how to contribute. It also provides guidelines and best +practices, and it summarizes coding and documentation styles. diff --git a/doc/source/guidelines/doc_practices.rst b/doc/source/guidelines/doc_practices.rst index 319bace1f..fde78c79b 100644 --- a/doc/source/guidelines/doc_practices.rst +++ b/doc/source/guidelines/doc_practices.rst @@ -452,3 +452,8 @@ On Windows, building a PDF is a manual process that you run locally: .\make latexpdf + +.. note:: + For the Table of Contents in the PDF file to generate correctly, ``index.rst`` files + must not include child sections. +