Include class members automatically, remove classes from navigation

docs/conf.py

@@ -1,48 +1,20 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
-#
-# scopus documentation build configuration file, created by
-# sphinx-quickstart on Wed Mar 22 10:36:17 2017.
-#
-# This file is execfile()d with the current directory set to its
-# containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
 
 import sys
 import os
 
-# If extensions (or modules to document with autodoc) are in another
-# directory, add these directories to sys.path here. If the directory is
-# relative to the documentation root, use os.path.abspath to make it
-# absolute, like shown here.
 sys.path.append(os.path.join(os.path.abspath(os.pardir)))
 autodoc_mock_imports = ["_tkinter"]
 
-# Get the project root dir, which is the parent dir of this
 cwd = os.getcwd()
 project_root = os.path.dirname(cwd)
-
-# Insert the project root dir as the first element in the PYTHONPATH.
-# This lets us ensure that the source package is imported, and that its
-# version is used.
 sys.path.insert(0, project_root)
 
 import scopus
 
-# -- General configuration ------------------------------------------------
-
-# If your documentation needs a minimal Sphinx version, state it here.
-#
+# General configuration
 needs_sphinx = '1.3'
-
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
@@ -52,61 +24,26 @@
     'sphinx.ext.napoleon',
     'sphinx.ext.viewcode']
 
-# Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
-
-# The suffix(es) of source filenames.
-# You can specify multiple suffix as a list of string:
-#
-# source_suffix = ['.rst', '.md']
 source_suffix = '.rst'
-
-# The master toctree document.
 master_doc = 'index'
-
-# General information about the project.
 project = 'scopus'
-copyright = '2017, John Kitchin and Michael E. Rose'
 author = 'John Kitchin and Michael E. Rose'
+copyright = ','.join(['2017', author])
+
+version = scopus.__version__
+release = scopus.__version__
 
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-# version = scopus.__version__
-# The full version, including alpha/beta/rc tags.
-# release = scopus.__version__
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#
-# This is also used if you do content translation via gettext catalogs.
-# Usually you set "language" from the command line for these cases.
 language = None
 
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This patterns also effect to html_static_path and html_extra_path
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
-# The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
-
-# If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
+autodoc_member_order = 'groupwise'
 
-
-# -- Options for HTML output ----------------------------------------------
-
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
+# Options for HTML output
 html_theme = 'alabaster'
-
-# Theme options are theme-specific and customize the look and feel of a theme
-# further.  For a list of options available for each theme, see the
-# documentation.
 html_theme_options = {
     'github_user': 'scopus-api',
     'github_repo': 'scopus',
@@ -122,26 +59,14 @@
     ]
 }
 
-# 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']
 
-
-# -- Options for HTMLHelp output ------------------------------------------
-
-# If true, links to the reST sources are added to the pages.
+# Options for HTMLHelp output
 html_show_sourcelink = True
-
-# Output file base name for HTML help builder.
 htmlhelp_basename = 'scopusdoc'
-
-# Option to include docstrings in __init__
 autoclass_content = 'both'
 
-
-# -- Options for LaTeX output ---------------------------------------------
-
+# Options for LaTeX output
 latex_elements = {
     # The paper size ('letterpaper' or 'a4paper').
     #
@@ -160,30 +85,18 @@
     # 'figure_align': 'htbp',
 }
 
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-#  author, documentclass [howto, manual, or own class]).
 latex_documents = [
     (master_doc, 'scopus.tex', 'scopus Documentation',
-     'John Kitchin and Michael E. Rose', 'manual'),
+     author, 'manual'),
 ]
 
-
-# -- Options for manual page output ---------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
+# Options for manual page output
 man_pages = [
     (master_doc, 'scopus', 'scopus Documentation',
      [author], 1)
 ]
 
-
-# -- Options for Texinfo output -------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-#  dir menu entry, description, category)
+# Options for Texinfo output
 texinfo_documents = [
     (master_doc, 'scopus', 'scopus Documentation',
      author, 'scopus', 'One line description of project.',

docs/index.rst

@@ -13,7 +13,6 @@ scopus provides classes to interact with the various Scopus APIs (see https://de
 .. currentmodule:: scopus
 
 .. autosummary::
-   :toctree: reference/
 
    ScopusAbstract
    ScopusAuthor
@@ -25,7 +24,6 @@ There is one class to provide reports:
 
 
 .. autosummary::
-   :toctree: reference/
 
    report
 

docs/reference/scopus.ScopusAbstract.rst

@@ -4,44 +4,4 @@ scopus.ScopusAbstract
 .. currentmodule:: scopus
 
 .. autoclass:: ScopusAbstract
-
-   .. rubric:: Methods
-
-   .. autosummary::
-
-      ~ScopusAbstract.get_corresponding_author_info
-
-   .. rubric:: Attributes
-
-   .. autosummary::
-
-      ~ScopusAbstract.affiliations
-      ~ScopusAbstract.aggregationType
-      ~ScopusAbstract.article_number
-      ~ScopusAbstract.authors
-      ~ScopusAbstract.bibtex
-      ~ScopusAbstract.citationLanguage
-      ~ScopusAbstract.citationType
-      ~ScopusAbstract.citedby_count
-      ~ScopusAbstract.coverDate
-      ~ScopusAbstract.doi
-      ~ScopusAbstract.endingPage
-      ~ScopusAbstract.html
-      ~ScopusAbstract.issn
-      ~ScopusAbstract.issueIdentifier
-      ~ScopusAbstract.latex
-      ~ScopusAbstract.nauthors
-      ~ScopusAbstract.pageRange
-      ~ScopusAbstract.publicationName
-      ~ScopusAbstract.publisher
-      ~ScopusAbstract.refcount
-      ~ScopusAbstract.references
-      ~ScopusAbstract.ris
-      ~ScopusAbstract.source_id
-      ~ScopusAbstract.srctype
-      ~ScopusAbstract.startingPage
-      ~ScopusAbstract.subjectAreas
-      ~ScopusAbstract.title
-      ~ScopusAbstract.url
-      ~ScopusAbstract.volume
-      ~ScopusAbstract.website
+   :members:

docs/reference/scopus.ScopusAffiliation.rst

@@ -4,16 +4,4 @@ scopus.ScopusAffiliation
 .. currentmodule:: scopus
 
 .. autoclass:: ScopusAffiliation
-
-   .. rubric:: Attributes
-
-   .. autosummary::
-
-      ~ScopusAffiliation.address
-      ~ScopusAffiliation.affiliation_id
-      ~ScopusAffiliation.city
-      ~ScopusAffiliation.country
-      ~ScopusAffiliation.name
-      ~ScopusAffiliation.nauthors
-      ~ScopusAffiliation.ndocuments
-      ~ScopusAffiliation.url
+   :members:

docs/reference/scopus.ScopusAuthor.rst

@@ -4,37 +4,4 @@ scopus.ScopusAuthor
 .. currentmodule:: scopus
 
 .. autoclass:: ScopusAuthor
-
-   .. rubric:: Methods
-
-   .. autosummary::
-
-      ~ScopusAuthor.author_impact_factor
-      ~ScopusAuthor.get_abstracts
-      ~ScopusAuthor.get_coauthors
-      ~ScopusAuthor.get_document_eids
-      ~ScopusAuthor.get_document_summary
-      ~ScopusAuthor.n_first_author_papers
-      ~ScopusAuthor.n_journal_articles
-      ~ScopusAuthor.n_last_author_papers
-      ~ScopusAuthor.n_yearly_publications
-
-   .. rubric:: Attributes
-
-   .. autosummary::
-
-      ~ScopusAuthor.affiliation_history
-      ~ScopusAuthor.author_id
-      ~ScopusAuthor.citedby_url
-      ~ScopusAuthor.coauthor_url
-      ~ScopusAuthor.current_affiliation
-      ~ScopusAuthor.date_created
-      ~ScopusAuthor.firstname
-      ~ScopusAuthor.hindex
-      ~ScopusAuthor.lastname
-      ~ScopusAuthor.name
-      ~ScopusAuthor.ncited_by
-      ~ScopusAuthor.ncoauthors
-      ~ScopusAuthor.ndocuments
-      ~ScopusAuthor.orcid
-      ~ScopusAuthor.scopus_url
+   :members:

docs/reference/scopus.ScopusSearch.rst

@@ -4,10 +4,4 @@ scopus.ScopusSearch
 .. currentmodule:: scopus
 
 .. autoclass:: ScopusSearch
-
-   .. rubric:: Attributes
-
-   .. autosummary::
-
-      ~ScopusSearch.EIDS
-      ~ScopusSearch.org_summary
+    :members: