Skip to content

doc/Enhance PDF generation section and README #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 16, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://dev.docs.pyansys.com>`_.
A link to the web-based version of this `guide <https://dev.docs.pyansys.com>`_
is available in the 'About' area for the `dev-guide <https://github.com/pyansys/dev-guide>`_
repository. A link to a PDF version of this guide is available in the `Releases
<https://github.com/pyansys/about/releases>`_ section under 'Assets'.

A PDF version of this guide can be found in the release notes in `Releases
<https://github.com/pyansys/about/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.
5 changes: 5 additions & 0 deletions doc/source/guidelines/doc_practices.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.