Skip to content

Commit 6478ede

Browse files
committed
fix minor docs issues
1 parent d38461a commit 6478ede

File tree

3 files changed

+11
-6
lines changed

3 files changed

+11
-6
lines changed

CONTRIBUTING.rst

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ you created the branch, check the section on
229229
:ref:`updating a PR <contributing_changes_update-pull-request>`.
230230

231231

232-
From here, you now can move forward to
232+
From here, you now can move forward to
233233

234234
- contribute to the documentation (see below)
235235
- contribute to the :ref:`code base <contributing_code>`
@@ -267,7 +267,7 @@ Some other important things to know about the docs:
267267
- The pyDataverse documentation consists of two parts:
268268

269269
- the docstrings in the code itself and
270-
- the docs in the folder ``src/pyDataverse/doc/``
270+
- the docs in the folder ``src/pyDataverse/docs/``
271271

272272
- The docstrings provide a clear explanation of the usage of the individual functions, while the documentation consists of tutorial-like overviews per topic together with some other information (what’s new, installation, this page you're viewing right now, etc).
273273
- The docstrings follow the `Numpy Docstring Standard <https://numpydoc.readthedocs.io/en/latest/format.html>`_.
@@ -871,6 +871,3 @@ You can find the full release history at :ref:`community_history` and on
871871
**Versioning**
872872

873873
For pyDataverse, `Semantic versioning <https://semver.org/>`_ is used for releases.
874-
875-
876-
.. _contributing_resources:

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@
55
pyDataverse is a Python module for [Dataverse](http://dataverse.org).
66
It helps to access the Dataverse [API's](http://guides.dataverse.org/en/latest/api/index.html) and manipulate, validate, import and export all Dataverse data-types (Dataverse, Dataset, Datafile).
77

8-
**Find out more: [Read the Docs](https://pydataverse.readthedocs.io/en/latest/)**
8+
**Find out more: [pyDataverse Documentation](https://pydataverse.readthedocs.io/en/latest/)**

src/pyDataverse/docs/source/reference.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ Where pyDataverse depends on external libraries, we document the most
1010
important right here and provide links to the canonical documentation outside of scope.
1111

1212

13+
.. _reference_api:
14+
1315
API Interface
1416
-----------------------------
1517

@@ -19,6 +21,8 @@ Access all of Dataverse APIs.
1921
:members:
2022

2123

24+
.. _reference_models:
25+
2226
Models Interface
2327
-----------------------------
2428

@@ -29,6 +33,8 @@ and `Datafile`). This includes import, export and manipulation.
2933
:inherited-members:
3034

3135

36+
.. _reference_utils:
37+
3238
Utils Interface
3339
-----------------------------
3440

@@ -38,6 +44,8 @@ Helper functions.
3844
:members:
3945

4046

47+
.. _reference_exceptions:
48+
4149
Exceptions
4250
-----------------------------
4351

0 commit comments

Comments
 (0)