Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Docker-in-Docker (DinD) capabilities of public runners deactivated.
More info
Open sidebar
limbra
limbra
Commits
c6cd8408
Commit
c6cd8408
authored
Oct 19, 2015
by
LE GAC Renaud
Browse files
Update the documentation.
parent
0e463b17
Changes
49
Hide whitespace changes
Inline
Side-by-side
Showing
9 changed files
with
43 additions
and
13 deletions
+43
-13
docs/api/generated/invenio_tools.base.MSG_NO_COUNTRY.rst
docs/api/generated/invenio_tools.base.MSG_NO_COUNTRY.rst
+6
-0
docs/api/generated/invenio_tools.base.MSG_NO_PUBLISHER.rst
docs/api/generated/invenio_tools.base.MSG_NO_PUBLISHER.rst
+6
-0
docs/api/generated/invenio_tools.base.MSG_WELL_FORMED_COLLABORATION.rst
...ated/invenio_tools.base.MSG_WELL_FORMED_COLLABORATION.rst
+6
-0
docs/api/generated/invenio_tools.checkandfix.load_record.rst
docs/api/generated/invenio_tools.checkandfix.load_record.rst
+0
-6
docs/api/generated/invenio_tools.load_record.rst
docs/api/generated/invenio_tools.load_record.rst
+6
-0
docs/api/harvester.rst
docs/api/harvester.rst
+8
-3
docs/api/invenio.rst
docs/api/invenio.rst
+4
-3
modules/harvest_tools/__init__.py
modules/harvest_tools/__init__.py
+6
-0
modules/invenio_tools/__init__.py
modules/invenio_tools/__init__.py
+1
-1
No files found.
docs/api/generated/invenio_tools.base.MSG_NO_COUNTRY.rst
0 → 100644
View file @
c6cd8408
invenio_tools.base.MSG_NO_COUNTRY
=================================
.. currentmodule:: invenio_tools.base
.. autodata:: MSG_NO_COUNTRY
\ No newline at end of file
docs/api/generated/invenio_tools.base.MSG_NO_PUBLISHER.rst
0 → 100644
View file @
c6cd8408
invenio_tools.base.MSG_NO_PUBLISHER
===================================
.. currentmodule:: invenio_tools.base
.. autodata:: MSG_NO_PUBLISHER
\ No newline at end of file
docs/api/generated/invenio_tools.base.MSG_WELL_FORMED_COLLABORATION.rst
0 → 100644
View file @
c6cd8408
invenio_tools.base.MSG_WELL_FORMED_COLLABORATION
================================================
.. currentmodule:: invenio_tools.base
.. autodata:: MSG_WELL_FORMED_COLLABORATION
\ No newline at end of file
docs/api/generated/invenio_tools.checkandfix.load_record.rst
deleted
100644 → 0
View file @
0e463b17
invenio_tools.checkandfix.load_record
=====================================
.. currentmodule:: invenio_tools.checkandfix
.. autofunction:: load_record
\ No newline at end of file
docs/api/generated/invenio_tools.load_record.rst
0 → 100644
View file @
c6cd8408
invenio_tools.load_record
=====================================
.. currentmodule:: invenio_tools
.. autofunction:: load_record
\ No newline at end of file
docs/api/harvester.rst
View file @
c6cd8408
...
...
@@ -6,15 +6,17 @@ The *harvest_tools* package contains all classes to harvester the invenio
store and to load the publication in the database.
The base class is :class:`.Automaton`.
All the other classes inherited form :class:`.Automaton`.
They specialise the work for :class:`.Articles`, :class:`.Notes`,
All the other classes inherited from it.
Inherited classes specialise the work for :class:`.Articles`, :class:`.Notes`,
:class:`.Preprints`, :class:`.Proceedings`, :class:`.Reports`,
:class:`.Talks` and :class:`.Thesis`.
The automaton is instantiated by the factory :func:`.build_harvester_tool`,
for a given category of publication.
The module also contains the class :class:`.CheckAndFix` to detect and to
correct record non-conformities.
Constants
^^^^^^^^^
.. currentmodule:: harvest_tools
...
...
@@ -27,6 +29,8 @@ Constants
~base.MSG_FIX_ORIGIN
~base.MSG_IN_DB
~base.MSG_LOAD
~base.MSG_NO_ENTRY
~base.MSG_TOOMANY_SYNONYM
Factory
^^^^^^^
...
...
@@ -70,6 +74,7 @@ Classes
~automaton.Automaton
~articles.Articles
~checkandfix.CheckAndFix
~notes.Notes
~preprints.Preprints
~proceedings.Proceedings
...
...
docs/api/invenio.rst
View file @
c6cd8408
...
...
@@ -10,7 +10,6 @@ The main classes are:
* :class:`.InvenioStore` to search publications in the store,
* :class:`.Marc12` to instantiate the record associated to a publication.
* :class:`.RecordPubli`, :class:`.RecordConf`, :class:`.RecordThesis`
* :class:`.CheckAndFix` to detect and to correct record non-conformities.
Constants
^^^^^^^^^
...
...
@@ -22,7 +21,10 @@ Constants
~base.ARXIV
~base.ARXIV_PDF
~base.MSG_NO_CONF
~base.MSG_NO_COUNTRY
~base.MSG_NO_PUBLISHER
~base.MSG_NO_THESIS
~base.MSG_WELL_FORMED_COLLABORATION
~base.OAI_URL
~base.REG_ARXIV_NUMBER
~base.REG_AUTHOR
...
...
@@ -41,7 +43,7 @@ Helper functions
~base.is_institute
~base.is_thesis
~
checkandfix.
load_record
~load_record
Classes
^^^^^^^
...
...
@@ -50,7 +52,6 @@ Classes
.. autosummary::
:toctree: generated/
~checkandfix.CheckAndFix
~inveniostore.InvenioStore
~iterrecord.IterRecord
~marc12.Marc12
...
...
modules/harvest_tools/__init__.py
View file @
c6cd8408
...
...
@@ -4,6 +4,12 @@ and to push them in the database.
"""
from
base
import
(
DRY_RUN
,
MSG_CRASH
,
MSG_FIX_ORIGIN
,
MSG_IN_DB
,
MSG_LOAD
,
MSG_NO_ENTRY
,
MSG_TOOMANY_SYNONYM
,
family_name_fr
,
format_author_fr
,
search_synonym
)
...
...
modules/invenio_tools/__init__.py
View file @
c6cd8408
...
...
@@ -42,7 +42,7 @@ def load_record(host, record_id):
Args:
host (unicode): host of the store.
Possible values are ``cds.cern.ch`` or ``inspirehep.net``.
record_id (int
eger
): the record identifier in the store
record_id (int): the record identifier in the store
Returns:
Record: the decoded record.
...
...
Prev
1
2
3
Next
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment