Skip to content

Commit de08e17

Browse files
authored
doc/Enhance PDF generation section and README (#48)
1 parent cf531e4 commit de08e17

File tree

2 files changed

+16
-7
lines changed

2 files changed

+16
-7
lines changed

README.rst

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,19 @@
22
PyAnsys Developer's Guide
33
#########################
44

5-
This guide serves as the central document for:
5+
The *PyAnsys Developer's Guide* is the central document for:
66

7-
- Ansys developers who want to create and "own" libraries
7+
- Ansys developers who want to create and "own" PyAnsys libraries
88
- Anyone in the Python community who wants to contribute to a
9-
library
9+
PyAnsys library
1010
- Anyone who is interested in learning more about the PyAnsys
11-
project and libraries
11+
project and PyAnsys libraries
1212

13-
Web-based documentation can be found in `PyAnsys Developer's Guide <https://dev.docs.pyansys.com>`_.
13+
A link to the web-based version of this `guide <https://dev.docs.pyansys.com>`_
14+
is available in the 'About' area for the `dev-guide <https://github.com/pyansys/dev-guide>`_
15+
repository. A link to a PDF version of this guide is available in the `Releases
16+
<https://github.com/pyansys/about/releases>`_ section under 'Assets'.
1417

15-
A PDF version of this guide can be found in the release notes in `Releases
16-
<https://github.com/pyansys/about/releases>`_.
18+
This guide provides an overview that describes the PyAnsys project organization,
19+
project administration, and how to contribute. It also provides guidelines and best
20+
practices, and it summarizes coding and documentation styles.

doc/source/guidelines/doc_practices.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -452,3 +452,8 @@ On Windows, building a PDF is a manual process that you run locally:
452452
453453
.\make latexpdf
454454
455+
456+
.. note::
457+
For the Table of Contents in the PDF file to generate correctly, ``index.rst`` files
458+
must not include child sections.
459+

0 commit comments

Comments
 (0)