Put examples in documentation

docs/source/arxivcheck.rst

@@ -0,0 +1,5 @@
+==========
+arxivcheck
+==========
+.. automodule:: arxivcheck.arxiv
+	:members:

docs/source/conf.py

@@ -15,6 +15,7 @@
 import os
 import sys
 sys.path.insert(0, os.path.abspath('../..'))
+sys.path.insert(0, os.path.abspath('..'))
 sys.setrecursionlimit(1500)
 
 # -- Project information -----------------------------------------------------

docs/source/examples.rst

@@ -0,0 +1,52 @@
+========
+Examples
+========
+
+Given a arxiv id...
+--------------------
+
+.. code-block:: bash
+
+   $ arxivcheck 1601.02785
+
+Given a arxiv title
+-------------------
+
+.. code-block:: bash
+
+    $ arxivcheck -t Periodic Table of Topological
+
+Given a file of titles or ids
+-----------------------------
+
+
+.. code-block:: bash
+
+    $ arxivcheck -i  arxivs.txt
+
+check if has been published, and then returns the updated bib
+return outputs like
+
+.. code-block:: bash
+
+    @article{2007Karianearxiv:math/0703567v2,
+        author = {Kariane Calta and John Smillie},
+        journal = {arxiv:math/0703567v2},
+        title = {Algebraically periodic translation surfaces},
+        url = {http://arxiv.org/abs/math/0703567v2},
+        year = {2007}
+    }
+
+    @article{Bradlyn_2016,
+        doi = {10.1126/science.aaf5037},
+        url = {https://doi.org/10.1126%2Fscience.aaf5037},
+        year = 2016,
+        month = {jul},
+        publisher = {American Association for the Advancement of Science ({AAAS})},
+        volume = {353},
+        number = {6299},
+        pages = {aaf5037},
+        author = {Barry Bradlyn and Jennifer Cano and Zhijun Wang and M. G. Vergniory and C. Felser and R. J. Cava and B. Andrei Bernevig},
+        title = {Beyond Dirac and Weyl fermions: Unconventional quasiparticles in conventional crystals},
+        journal = {Science}
+    }

docs/source/index.rst

@@ -2,13 +2,14 @@ Welcome to arxivcheck's documentation!
 ======================================
 
 .. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+    :maxdepth: 3
+    :caption: Contents:
+
+    install
+    arxivcheck
+    examples
+
 
-arxivcheck
-==========
-.. automodule:: arxivcheck.arxiv
-	:members:
 
 Indices and tables
 ==================

docs/source/install.rst

@@ -0,0 +1,7 @@
+=======
+Install
+=======
+
+.. code-block:: bash
+
+    pip install arxivcheck