doc: add PDF document

misho104 · Mar 3, 2019 · 3418e83 · 3418e83
1 parent 7bb51f1
commit 3418e83
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -3,7 +3,6 @@
 .mypy_cache
 /poetry.lock
 /pip-wheel-metadata
-/docs/doc.pdf
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

diff --git a/README.md b/README.md
@@ -132,7 +132,8 @@ For more customization, you can use this package from your own code with more de
 Document
 --------
 
-The document is provided on [readthedocs.io](https://susy-cross-section.readthedocs.io), together with [API references](https://susy-cross-section.readthedocs.io/en/latest/susy_cross_section.html).
+The document is provided on [readthedocs.io](https://susy-cross-section.readthedocs.io), together with [API references](https://susy-cross-section.readthedocs.io/en/latest/api_reference.html).
+A [PDF file](https://github.com/misho104/susy_cross_section/blob/master/docs/doc.pdf) is also distributed with this package.
 
 License and Citation Policy
 ---------------------------

diff --git a/docs/conf.py b/docs/conf.py
@@ -167,7 +167,9 @@
 ]
 
 latex_abstract = r"""
-TBW
+\texttt{susy\_cross\_section} is a Python package to handle cross-section grid tables regardless of their format.
+This package may parse any table-like grid files as a \texttt{pandas.DataFrame} object, and with built-in interpolators users can get interpolated values of cross sections together with uncertainties.
+Several table data is also pre-installed in this package.
 """
 
 latex_preamble = r"""

diff --git a/docs/doc.pdf b/docs/doc.pdf