Skip to content

Commit 359d890

Browse files
author
Gerit Wagner
committed
update docs
1 parent de7004b commit 359d890

484 files changed

Lines changed: 9937 additions & 5 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎colrev/constants.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#!/usr/bin/env python
2-
"""Constants for CoLRev"""
2+
"""Constants, including filepaths, fields, entrytypes, colrev_status, etc."""
33
# pylint: disable=too-few-public-methods
44
# pylint: disable=colrev-missed-constant-usage
55
import importlib.util

‎colrev/loader/__init__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""CoLRev loader"""
1+
"""Loaders for different data formats, including BibTex, RIS, CSV/Excel files"""
22

33
__author__ = """Gerit Wagner"""
44
__email__ = "gerit.wagner@uni-bamberg.de"

‎colrev/record/__init__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""CoLRev records"""
1+
"""Records containing title, author, year, etc."""
22

33
__author__ = """Gerit Wagner"""
44
__email__ = "gerit.wagner@uni-bamberg.de"

‎colrev/writer/__init__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""CoLRev writer"""
1+
"""Writers for different data formats, including BibTex, RIS, CSV/Excel files"""
22

33
__author__ = """Gerit Wagner"""
44
__email__ = "gerit.wagner@uni-bamberg.de"

‎docs/source/conf.py‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import os
22
import sys
3+
from datetime import datetime
34

45
import sphinx_rtd_theme
56

@@ -32,8 +33,8 @@
3233
# -- Project information -----------------------------------------------------
3334

3435
project = "CoLRev"
35-
copyright = "2023, Gerit Wagner and Julian Prester"
3636
author = "Gerit Wagner and Julian Prester"
37+
copyright = f"{datetime.now().year}, {author}"
3738

3839
# The full version, including alpha/beta/rc tags
3940
release = colrev_version

‎docs/source/dev_docs/api.rst‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,53 @@ The package interfaces are documented :doc:`here </dev_docs/packages>`.
2020
:recursive:
2121

2222
colrev
23+
24+
**Interfaces**
25+
26+
.. autosummary::
27+
:toctree:
28+
:template: custom-module-template.rst
29+
:recursive:
30+
31+
colrev.ui_cli
32+
colrev.hooks
33+
34+
**High-level (project)**
35+
36+
.. autosummary::
37+
:toctree:
38+
:template: custom-module-template.rst
39+
:recursive:
40+
41+
colrev.review_manager
42+
colrev.settings
43+
colrev.ops
44+
colrev.process
45+
colrev.dataset
46+
47+
**High-level (environment)**
48+
49+
.. autosummary::
50+
:toctree:
51+
:template: custom-module-template.rst
52+
:recursive:
53+
54+
colrev.env
55+
colrev.package_manager
56+
colrev.packages
57+
58+
**Low-level**
59+
60+
.. autosummary::
61+
:toctree:
62+
:template: custom-module-template.rst
63+
:recursive:
64+
65+
66+
colrev.constants
67+
colrev.logger
68+
colrev.exceptions
69+
colrev.paths
70+
colrev.loader
71+
colrev.writer
72+
colrev.record

‎docs/source/dev_docs/colrev.constants.Colors.rst‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
colrev.constants.Colors
2+
=======================
3+
4+
.. currentmodule:: colrev.constants
5+
6+
.. autoclass:: Colors
7+
:members:
8+
:show-inheritance:
9+
:inherited-members:
10+
:special-members: __call__, __add__, __mul__
11+
12+
13+
14+
15+
16+
17+
18+
.. rubric:: Attributes
19+
20+
.. autosummary::
21+
22+
~Colors.BLUE
23+
~Colors.END
24+
~Colors.GREEN
25+
~Colors.ORANGE
26+
~Colors.RED

‎docs/source/dev_docs/colrev.constants.DefectCodes.rst‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
colrev.constants.DefectCodes
2+
============================
3+
4+
.. currentmodule:: colrev.constants
5+
6+
.. autoclass:: DefectCodes
7+
:members:
8+
:show-inheritance:
9+
:inherited-members:
10+
:special-members: __call__, __add__, __mul__
11+
12+
13+
14+
15+
16+
17+
18+
.. rubric:: Attributes
19+
20+
.. autosummary::
21+
22+
~DefectCodes.CONTAINER_TITLE_ABBREVIATED
23+
~DefectCodes.DOI_NOT_MATCHING_PATTERN
24+
~DefectCodes.ERRONEOUS_SYMBOL_IN_FIELD
25+
~DefectCodes.ERRONEOUS_TERM_IN_FIELD
26+
~DefectCodes.ERRONEOUS_TITLE_FIELD
27+
~DefectCodes.HTML_TAGS
28+
~DefectCodes.IDENTICAL_VALUES_BETWEEN_TITLE_AND_CONTAINER
29+
~DefectCodes.INCOMPLETE_FIELD
30+
~DefectCodes.INCONSISTENT_CONTENT
31+
~DefectCodes.INCONSISTENT_WITH_DOI_METADATA
32+
~DefectCodes.INCONSISTENT_WITH_ENTRYTYPE
33+
~DefectCodes.ISBN_NOT_MATCHING_PATTERN
34+
~DefectCodes.LANGUAGE_FORMAT_ERROR
35+
~DefectCodes.LANGUAGE_UNKNOWN
36+
~DefectCodes.MISSING
37+
~DefectCodes.MOSTLY_ALL_CAPS
38+
~DefectCodes.NAME_ABBREVIATED
39+
~DefectCodes.NAME_FORMAT_SEPARTORS
40+
~DefectCodes.NAME_FORMAT_TITLES
41+
~DefectCodes.NAME_PARTICLES
42+
~DefectCodes.PAGE_RANGE
43+
~DefectCodes.PUBMED_ID_NOT_MATCHING_PATTERN
44+
~DefectCodes.RECORD_NOT_IN_TOC
45+
~DefectCodes.THESIS_WITH_MULTIPLE_AUTHORS
46+
~DefectCodes.YEAR_FORMAT

‎docs/source/dev_docs/colrev.constants.ENTRYTYPES.rst‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
colrev.constants.ENTRYTYPES
2+
===========================
3+
4+
.. currentmodule:: colrev.constants
5+
6+
.. autoclass:: ENTRYTYPES
7+
:members:
8+
:show-inheritance:
9+
:inherited-members:
10+
:special-members: __call__, __add__, __mul__
11+
12+
13+
14+
.. rubric:: Methods
15+
16+
.. autosummary::
17+
:nosignatures:
18+
19+
~ENTRYTYPES.get_all
20+
21+
22+
23+
24+
25+
.. rubric:: Attributes
26+
27+
.. autosummary::
28+
29+
~ENTRYTYPES.ARTICLE
30+
~ENTRYTYPES.BACHELORTHESIS
31+
~ENTRYTYPES.BOOK
32+
~ENTRYTYPES.CONFERENCE
33+
~ENTRYTYPES.INBOOK
34+
~ENTRYTYPES.INCOLLECTION
35+
~ENTRYTYPES.INPROCEEDINGS
36+
~ENTRYTYPES.MASTERSTHESIS
37+
~ENTRYTYPES.MISC
38+
~ENTRYTYPES.ONLINE
39+
~ENTRYTYPES.PHDTHESIS
40+
~ENTRYTYPES.PROCEEDINGS
41+
~ENTRYTYPES.SOFTWARE
42+
~ENTRYTYPES.TECHREPORT
43+
~ENTRYTYPES.THESIS
44+
~ENTRYTYPES.UNPUBLISHED

‎docs/source/dev_docs/colrev.constants.EndpointType.rst‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
colrev.constants.EndpointType
2+
=============================
3+
4+
.. currentmodule:: colrev.constants
5+
6+
.. autoclass:: EndpointType
7+
:members:
8+
:show-inheritance:
9+
:inherited-members:
10+
:special-members: __call__, __add__, __mul__
11+
12+
13+
14+
15+
16+
17+
18+
.. rubric:: Attributes
19+
20+
.. autosummary::
21+
22+
~EndpointType.review_type
23+
~EndpointType.search_source
24+
~EndpointType.prep
25+
~EndpointType.prep_man
26+
~EndpointType.dedupe
27+
~EndpointType.prescreen
28+
~EndpointType.pdf_get
29+
~EndpointType.pdf_get_man
30+
~EndpointType.pdf_prep
31+
~EndpointType.pdf_prep_man
32+
~EndpointType.screen
33+
~EndpointType.data
34+
~EndpointType.na

0 commit comments

Comments
 (0)