Skip to content

Commit

Permalink
Documentation improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
byrdie committed Oct 28, 2023
1 parent fe5abee commit 517b5c9
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[![PyPI version](https://badge.fury.io/py/aastex.svg)](https://badge.fury.io/py/aastex)

This Python library extends [PyLaTeX](https://github.com/JelteF/PyLaTeX) to support the
AASTeX LaTeX package.
[AASTeX LaTeX package](https://journals.aas.org/aastex-package-for-manuscript-preparation/).

## Installation

Expand Down
9 changes: 6 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
Introduction
============

This Python library extends `PyLaTeX <https://github.com/JelteF/PyLaTeX>`_ to support the
AASTeX LaTeX package.
This Python library extends `PyLaTeX <https://github.com/JelteF/PyLaTeX>`_
to support the `AASTeX LaTeX package <https://journals.aas.org/aastex-package-for-manuscript-preparation/>`_.

Please see the `PyLaTeX documentation <https://jeltef.github.io/PyLaTeX/current/>`_
for more information on how to use this package.

|
Expand Down Expand Up @@ -56,7 +59,7 @@ Here is a simple example showing some of the basic features of :mod:`aastex`.
path_pdf = pathlib.Path("an_interesting_article.pdf")
doc.generate_pdf(filepath=path_pdf.with_suffix(""))

Which generates the following PDF:
Which outputs the following PDF:

.. jupyter-execute::
:hide-code:
Expand Down

0 comments on commit 517b5c9

Please sign in to comment.