Commit f03f2faf authored by LE GAC Renaud's avatar LE GAC Renaud
Browse files

Update the API documentation.

parent a9ee293e
......@@ -55,7 +55,7 @@ extensions = ['sphinx.ext.autodoc',
'sphinx.ext.viewcode']
# autosummary configuration
autosummary_generate = False
autosummary_generate = True
# intersphinx configuration
intersphinx_mapping = {'python': ('http://docs.python.org/2.7', None)}
......
harvest_tools.automaton.Automaton.__init__
==========================================
.. currentmodule:: harvest_tools.automaton
.. automethod:: Automaton.__init__
\ No newline at end of file
harvest_tools.automaton.Automaton.get_create_collaboration
==========================================================
.. currentmodule:: harvest_tools.automaton
.. automethod:: Automaton.get_create_collaboration
\ No newline at end of file
harvest_tools.automaton.Automaton.get_create_publisher
harvest_tools.automaton.Automaton.search_collaboration
======================================================
.. currentmodule:: harvest_tools.automaton
.. automethod:: Automaton.get_create_publisher
\ No newline at end of file
.. automethod:: Automaton.search_collaboration
\ No newline at end of file
harvest_tools.automaton.Automaton.search_country
================================================
.. currentmodule:: harvest_tools.automaton
.. automethod:: Automaton.search_country
\ No newline at end of file
harvest_tools.automaton.Automaton.search_publisher
==================================================
.. currentmodule:: harvest_tools.automaton
.. automethod:: Automaton.search_publisher
\ No newline at end of file
......@@ -12,15 +12,9 @@ harvest_tools.articles.Articles
:toctree: articles/
~Articles.check_record
~Articles.decode_xml
~Articles.get_create_collaboration
~Articles.get_create_publisher
~Articles.get_record_by_fields
~Articles.get_record_by_origin
~Articles.insert_record
~Articles.process_url
~Articles.process_xml
~Articles.report
......
......@@ -4,23 +4,22 @@ harvest_tools.automaton.Automaton
.. currentmodule:: harvest_tools.automaton
.. autoclass:: Automaton
:show-inheritance:
.. rubric:: Methods
.. autosummary::
:toctree: automaton/
~Automaton.__init__
~Automaton.check_record
~Automaton.decode_xml
~Automaton.get_create_collaboration
~Automaton.get_create_publisher
~Automaton.get_record_by_fields
~Automaton.insert_record
~Automaton.process_url
~Automaton.process_xml
~Automaton.report
~Automaton.search_collaboration
~Automaton.search_country
~Automaton.search_publisher
......
......@@ -12,14 +12,7 @@ harvest_tools.notes.Notes
:toctree: notes/
~Notes.check_record
~Notes.decode_xml
~Notes.get_create_collaboration
~Notes.get_create_publisher
~Notes.get_record_by_fields
~Notes.insert_record
~Notes.process_url
~Notes.process_xml
~Notes.report
......
......@@ -12,14 +12,7 @@ harvest_tools.preprints.Preprints
:toctree: preprints/
~Preprints.check_record
~Preprints.decode_xml
~Preprints.get_create_collaboration
~Preprints.get_create_publisher
~Preprints.get_record_by_fields
~Preprints.insert_record
~Preprints.process_url
~Preprints.process_xml
~Preprints.report
......
......@@ -12,14 +12,7 @@ harvest_tools.proceedings.Proceedings
:toctree: proceedings/
~Proceedings.check_record
~Proceedings.decode_xml
~Proceedings.get_create_collaboration
~Proceedings.get_create_publisher
~Proceedings.get_record_by_fields
~Proceedings.insert_record
~Proceedings.process_url
~Proceedings.process_xml
~Proceedings.report
......
......@@ -12,14 +12,7 @@ harvest_tools.reports.Reports
:toctree: reports/
~Reports.check_record
~Reports.decode_xml
~Reports.get_create_collaboration
~Reports.get_create_publisher
~Reports.get_record_by_fields
~Reports.insert_record
~Reports.process_url
~Reports.process_xml
~Reports.report
......
......@@ -12,14 +12,7 @@ harvest_tools.talks.Talks
:toctree: talks/
~Talks.check_record
~Talks.decode_xml
~Talks.get_create_collaboration
~Talks.get_create_publisher
~Talks.get_record_by_fields
~Talks.insert_record
~Talks.process_url
~Talks.process_xml
~Talks.report
......
......@@ -12,14 +12,7 @@ harvest_tools.thesis.Thesis
:toctree: thesis/
~Thesis.check_record
~Thesis.decode_xml
~Thesis.get_create_collaboration
~Thesis.get_create_publisher
~Thesis.get_record_by_fields
~Thesis.insert_record
~Thesis.process_url
~Thesis.process_xml
~Thesis.report
......
......@@ -4,7 +4,6 @@ invenio_tools.checkandfix.CheckAndFix
.. currentmodule:: invenio_tools.checkandfix
.. autoclass:: CheckAndFix
:show-inheritance:
.. rubric:: Methods
......
......@@ -4,7 +4,6 @@ invenio_tools.inveniostore.InvenioStore
.. currentmodule:: invenio_tools.inveniostore
.. autoclass:: InvenioStore
:show-inheritance:
.. rubric:: Methods
......
......@@ -4,7 +4,6 @@ invenio_tools.iterrecord.IterRecord
.. currentmodule:: invenio_tools.iterrecord
.. autoclass:: IterRecord
:show-inheritance:
.. rubric:: Methods
......
......@@ -614,15 +614,15 @@ class Automaton(object):
logs=self.logs)
def search_collaboration(self, value):
"""Get the database collaboration identifier.
Create it, if it does not exist.
"""Get the database collaboration identifier using synonyms.
Create the collaboration, if it does not exist.
Args:
value (unicode): the name of the collaboration.
Returns:
int:
* the id of the collaboration.
* the id of the collaboration record.
* UNDEF_ID if value is not defined.
Raise:
......@@ -632,14 +632,14 @@ class Automaton(object):
return self._search("collaborations", "collaboration", value, True)
def search_country(self, value):
"""Get the database country identifier.
"""Get the database country identifier using synonyms.
Args:
value (unicode): the name of the country.
Returns:
int:
* the id of the country.
* the id of the country record.
* UNDEF_ID if value is not defined.
Raise:
......@@ -649,14 +649,14 @@ class Automaton(object):
return self._search("countries", "country", value)
def search_publisher(self, value):
"""Get the database publisher identifier.
"""Get the database publisher identifier using synonyms.
Args:
value (unicode): the abbreviation of the publisher.
Returns:
int:
* the id of the publisher.
* the id of the publisher record.
* UNDEF_ID if value is not defined.
Raise:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment