Merge pull request #217 from scholarly-python-package/develop

Develop

Author: programize-admin

README.md

@@ -0,0 +1,6 @@
+AuthorParser module
+-----------------------
+
+.. automodule:: scholarly.author_parser
+   :members:
+   :undoc-members:

docs/AuthorParser.rst

@@ -1,6 +1,6 @@
-Author module
+DataTypes module
 -----------------------
 
-.. automodule:: scholarly.author
+.. automodule:: scholarly.data_types
    :members:
    :undoc-members:

docs/Author.rst renamed to docs/DataTypes.rst

@@ -0,0 +1,7 @@
+
+ProxyGenerator module
+-----------------------
+
+.. automodule:: scholarly._proxy_generator
+   :members:
+   :undoc-members:

docs/ProxyGenerator.rst

@@ -1,7 +1,7 @@
-Publication module
+PublicationParser module
 ----------------------------
 
-.. automodule:: scholarly.publication
+.. automodule:: scholarly.publication_parser
    :members:
    :undoc-members:
    :show-inheritance:

docs/Publication.rst renamed to docs/PublicationParser.rst

@@ -12,6 +12,7 @@
 #
 import os
 import sys
+import sphinx_rtd_theme
 sys.path.insert(0, os.path.abspath('..'))
 
 
@@ -22,7 +23,7 @@
 author = 'Steven A. Cholewiak, Panos Ipeirotis, Victor Silva'
 
 # The full version, including alpha/beta/rc tags
-release = '0.3.1'
+release = '1.0b1'
 master_doc = 'index'
 
 # -- General configuration ---------------------------------------------------
@@ -36,6 +37,7 @@
     'sphinx.ext.viewcode',
     'sphinx.ext.githubpages',
     'sphinx.ext.doctest',
+    'sphinx_rtd_theme',
     #'sphinx.ext.napoleon'
 ]
 
@@ -65,7 +67,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# html_static_path = ['_static']
 
 
 # -- Extension configuration -------------------------------------------------

docs/conf.py

@@ -49,14 +49,15 @@ then retrieve the titles of the papers that cite his most popular
     print(author)
 
     # Print the titles of the author's publications
-    print([pub.bib['title'] for pub in author.publications])
+    print([pub['bib']['title'] for pub in author['publications']])
+
 
     # Take a closer look at the first publication
-    pub = author.publications[0].fill()
+    pub = scholarly.fill(author['publications'][0])
     print(pub)
 
     # Which papers cited that publication?
-    print([citation.bib['title'] for citation in pub.get_citedby()])
+    print([citation['bib']['title'] for citation in scholarly.citedby(pub)])
 
     # What is the Bibtex of that publication?
-    print(pub.bibtex)
+    scholarly.bibtex(pub)

docs/quickstart.rst

@@ -5,5 +5,7 @@ scholarly Package
    :maxdepth: 2
 
    scholarly_user
-   Author.rst
-   Publication.rst
+   AuthorParser.rst
+   PublicationParser.rst
+   ProxyGenerator.rst
+   DataTypes.rst

docs/scholarly.rst

@@ -8,4 +8,5 @@ stem
 fake_useragent
 selenium
 python-dotenv
-free-proxy
+free-proxy
+sphinx_rtd_theme

requirements.txt

@@ -1,3 +1,4 @@
 from ._scholarly import _Scholarly
 from ._proxy_generator import ProxyGenerator
+from .data_types import Author, Publication
 scholarly = _Scholarly()