Skip to content

Commit 12516c8

Browse files
github-actions[bot]github-actions
andauthored
Update documentation (#757)
Co-authored-by: github-actions <github-actions@github.com>
1 parent 68580e9 commit 12516c8

24 files changed

Lines changed: 2415 additions & 53 deletions

colrev/package_manager/package_endpoints.json

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -549,11 +549,6 @@
549549
}
550550
],
551551
"pdf_get": [
552-
{
553-
"package_endpoint_identifier": "colrev-scidb",
554-
"status": "|EXPERIMENTAL|",
555-
"short_description": "TODO (:doc:`instructions </manual/packages/colrev-scidb>`)"
556-
},
557552
{
558553
"package_endpoint_identifier": "colrev.download_from_website",
559554
"status": "|MATURING|",

docs/source/manual/package_endpoints.json

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -549,11 +549,6 @@
549549
}
550550
],
551551
"pdf_get": [
552-
{
553-
"package_endpoint_identifier": "colrev-scidb",
554-
"status": "|EXPERIMENTAL|",
555-
"short_description": "TODO (:doc:`instructions </manual/packages/colrev-scidb>`)"
556-
},
557552
{
558553
"package_endpoint_identifier": "colrev.download_from_website",
559554
"status": "|MATURING|",

docs/source/manual/packages.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,6 @@ Packages
140140
packages/colrev.scope_prescreen.rst
141141

142142

143-
packages/colrev-scidb.rst
144143
packages/colrev.download_from_website.rst
145144
packages/colrev.local_index.rst
146145
packages/colrev.unpaywall.rst

docs/source/manual/packages/colrev.critical_review.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Summary
5353

5454
A critical review is a form of research synthesis that rigorously evaluates existing literature to identify weaknesses, contradictions, and inconsistencies. It assesses each piece of literature against specific criteria to gauge its adequacy, thereby highlighting areas where current knowledge may be unreliable. This approach aids in directing future research by pinpointing specific problems and discrepancies that need to be addressed. Critical reviews are typically either selective or representative in nature, often omitting a comprehensive literature search, and may use various data synthesis methods rooted in either positivist or interpretivist epistemological positions.
5555

56-
If the focus is on research methods, a :doc:`critical methodological review <colrev.methodological_review>` may be appropriate.
56+
If the focus is on research methods, a `critical methodological review <colrev.methodological_review.html>`_ may be appropriate.
5757

5858
Characteristics
5959
---------------
@@ -78,8 +78,8 @@ Data extraction, analysis, and synthesis
7878
The following packages are automatically set up in a critical review:
7979

8080

81-
* :doc:`colrev.prisma <colrev.prisma>`
82-
* :doc:`colrev.paper_md <colrev.paper_md>`
81+
* `colrev.prisma <colrev.prisma.html>`_
82+
* `colrev.paper_md <colrev.paper_md.html>`_
8383

8484
Examples
8585
--------

docs/source/manual/packages/colrev.crossref.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,6 @@ Links
143143

144144

145145
* `Crossref <https://www.crossref.org/>`_
146-
* `License <https://www.crossref.org/documentation/retrieve-metadata/rest-api/tips-for-using-the-crossref-rest-api/>`_
146+
* `License <https://www.crossref.org/documentation/retrieve-metadata/rest-api/rest-api-metadata-license-information/>`_
147147
* `Crossref types <https://api.crossref.org/types>`_
148148
* `Issue: AND Operators not yet supported <https://github.com/fabiobatalha/crossrefapi/issues/20>`_

docs/source/manual/packages/colrev.dedupe.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ Summary
5454
BibDedupe is an open-source Python library for deduplication of bibliographic records, tailored for literature reviews. Unlike traditional deduplication methods, BibDedupe focuses on entity resolution, linking duplicate records instead of simply deleting them.
5555

5656

57-
.. image:: https://joss.theoj.org/papers/10.21105/joss.06318/status.svg
58-
:target: https://joss.theoj.org/papers/10.21105/joss.06318
57+
.. image:: https://joss.theoj.org/papers/b954027d06d602c106430e275fe72130/status.svg
58+
:target: https://joss.theoj.org/papers/b954027d06d602c106430e275fe72130
5959
:alt: status
6060

6161

@@ -100,4 +100,4 @@ Links
100100

101101
* `bib-dedupe <https://github.com/CoLRev-Environment/bib-dedupe>`_
102102
* `Documentation <https://colrev-environment.github.io/bib-dedupe/>`_
103-
* `Evaluation <https://github.com/CoLRev-Environment/bib-dedupe#evaluation>`_
103+
* `Evaluation <https://colrev-environment.github.io/bib-dedupe/evaluation.html>`_

docs/source/manual/packages/colrev.descriptive_review.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,10 +76,10 @@ Data extraction, analysis, and synthesis
7676
The following packages are automatically set up in a descriptive review:
7777

7878

79-
* :doc:`colrev.prisma <colrev.prisma>`
80-
* :doc:`colrev.profile <colrev.profile>`
81-
* :doc:`colrev.structured <colrev.structured>`
82-
* :doc:`colrev.paper_md <colrev.paper_md>`
79+
* `colrev.prisma <colrev.prisma.html>`_
80+
* `colrev.profile <colrev.profile.html>`_
81+
* `colrev.structured <colrev.structured.html>`_
82+
* `colrev.paper_md <colrev.paper_md.html>`_
8383

8484
Examples
8585
--------

docs/source/manual/packages/colrev.ebsco_host.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,12 +57,12 @@ search
5757
DB search
5858
^^^^^^^^^
5959

60-
Export is available after adding citations to a folder (\ `1 <https://connect.ebsco.com/s/article/How-to-Use-the-Export-Manager-in-EBSCOhost?language=en_US>`_\ ).
60+
Export is available after adding citations to a folder (\ `1 <https://connect.ebsco.com/s/article/How-to-Use-the-Export-Manager?language=en_US>`_\ ).
6161
Download search results and store in ``data/search/`` directory. API-access not yet available.
6262

6363
Links
6464
-----
6565

6666

67-
* `EBSCOHost <https://www.ebsco.com/products/research-databases/ebscohost-research-platform>`_
68-
* `EBSCOHost APIs <https://developer.ebsco.com/home/docs/available-apis-and-requirements>`_
67+
* `EBSCOHost <https://search.ebscohost.com/>`_
68+
* `EBSCOHost APIs <https://developer.ebsco.com/getting-started/available-apis>`_

docs/source/manual/packages/colrev.enlit.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,9 @@ Cite
7979

8080
Wagner, G., Empl, P., & Schryen, G. (2020, May). Designing a novel strategy for exploring literature corpora. In *Proceedings of the European Conference on Information Systems*. https://aisel.aisnet.org/ecis2020_rp/44/
8181

82-
Original repository: `link <https://github.com/fs-ise/enlit>`_
82+
Original repository: `link <https://github.com/digital-work-lab/enlit>`_
8383

8484
License
8585
-------
8686

87-
This project is licensed under the MIT License - see the `LICENSE <https://github.com/CoLRev-Environment/colrev/blob/main/LICENSE>`_ file for details.
87+
This project is licensed under the MIT License - see the `LICENSE <LICENSE>`_ file for details.

docs/source/manual/packages/colrev.files_dir.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ FILES search
6363
6464
6565
* PDF metadata extracted based on PDF hashes and the local_index (clone curations and run ``colrev env --index``\ ).
66-
* PDF metadata extracted based on `GROBID <https://github.com/grobidOrg/grobid>`_
66+
* PDF metadata extracted based on `GROBID <https://github.com/kermitt2/grobid>`_
6767

6868
For metadata curations, i.e., repositories containing all PDFs organized in directories for volumes/issues, it is possible to set the ``scope`` parameter in the ``settings.json``\ , ensuring that the journal name, entrytype, and volume/issue is set automatically.
6969

0 commit comments

Comments
 (0)