Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bind prefixes choices #1686

Merged
merged 20 commits into from
Apr 15, 2022
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions docs/docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,15 @@ These docs are generated with Sphinx.
Sphinx makes it very easy to pull in doc-strings from modules,
classes, methods, etc. When writing doc-strings, special reST fields
can be used to annotate parameters, return-types, etc. This makes for
pretty API docs. More information about sphinx can be found `here <https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html>`_.
pretty API docs. See `here <https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#info-field-lists>`_
for the Shinx documentation about these fields.

Building
--------

To build you must have the ``sphinx`` and some additional package installed.

The documentation's full set of requirements is listed in the ``sphinx-requirements.txt`` file within the :file:`docs/` directory.
To build you must have the ``sphinx`` and some additional package installed.
The full set of requirements is listed in the ``sphinx-requirements.txt`` file
within the :file:`docs/` directory.

To install the requirements for building documentation run:

Expand All @@ -26,15 +27,18 @@ To install the requirements for building documentation run:
pip install -r docs/sphinx-requirements.txt


Once you have all the requirements installed you can run this command in the rdflib root directory:
Once you have all the requirements installed you can run this command in the
rdflib root directory:

.. code-block:: bash

python setup.py build_sphinx

Docs will be generated in :file:`build/sphinx/html/` and API documentation, generated from doc-strings, will be placed in :file:`docs/apidocs/`.
Docs will be generated in :file:`build/sphinx/html/` and API documentation,
generated from doc-strings, will be placed in :file:`docs/apidocs/`.

There is also a `tox <https://tox.wiki/en/latest/>`_ environment for building documentation:
There is also a `tox <https://tox.wiki/en/latest/>`_ environment for building
documentation:

.. code-block:: bash

Expand Down
6 changes: 3 additions & 3 deletions docs/gettingstarted.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,13 @@ who hasn't worked with RDF before.*
The primary interface that RDFLib exposes for working with RDF is a
:class:`~rdflib.graph.Graph`.

RDFLib graphs are un-sorted containers; they have ordinary ``set``
RDFLib graphs are un-sorted containers; they have ordinary Python ``set``
operations (e.g. :meth:`~rdflib.Graph.add` to add a triple) plus
methods that search triples and return them in arbitrary order.

RDFLib graphs also redefine certain built-in Python methods in order
to behave in a predictable way: they `emulate container types
<http://docs.python.org/release/2.5.2/ref/sequence-types.html>`_ and
to behave in a predictable way: they `emulating container types
<https://docs.python.org/3.7/reference/datamodel.html#emulating-container-types>`_ and
are best thought of as a set of 3-item tuples ("triples", in RDF-speak):

.. code-block:: text
Expand Down
35 changes: 5 additions & 30 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,19 @@ RDFLib is a pure Python package for working with `RDF <http://www.w3.org/RDF/>`_

* **Parsers & Serializers**

* for RDF/XML, N3, NTriples, N-Quads, Turtle, TriX, JSON-LD, RDFa and Microdata
* for RDF/XML, N3, NTriples, N-Quads, Turtle, TriX, JSON-LD, HexTuples, RDFa and Microdata


* **Store implementations**

* for in-memory and persistent RDF storage, including remote SPARQL endpoints
* for memory stores
nicholascar marked this conversation as resolved.
Show resolved Hide resolved
* persistent, on-disk stores, using databases such as BerkeleyDB
* remote SPARQL endpoints

* **Graph interface**

* to a single graph
* or a conjunctive graph (multiple Named Graphs)
* or a dataset of graphs
* or to multiple Named Graphs within a dataset

* **SPARQL 1.1 implementation**

Expand Down Expand Up @@ -107,29 +108,3 @@ the tag ``[rdflib]``. A list of existing ``[rdflib]`` tagged questions is kept t
You might also like to join rdflib's dev mailing list: `<https://groups.google.com/group/rdflib-dev>`__

The chat is available at `gitter <https://gitter.im/RDFLib/rdflib>`_ or via matrix `#RDFLib_rdflib:gitter.im <https://matrix.to/#/#RDFLib_rdflib:gitter.im>`_.



Glossary
--------

Here are a few RDF and Python terms referred to in this documentation. They are linked to wherever they occur.

.. glossary::

functional property
Properties than can only occur once for a resource, i.e. for any relation (triple, in RDF) ``x p y``,
if ``p`` is functional, for any individual ``x``, there can be at most one individual ``y``.

OWL
The OWL 2 Web Ontology Language, informally OWL 2 or just OWL, is an ontology language for the Semantic Web
with formally defined meaning. OWL 2 ontologies provide classes, properties, individuals, and data values and
are stored as Semantic Web documents. OWL 2 ontologies can be used along with information written in RDF, and
OWL 2 ontologies themselves are primarily exchanged as RDF documents. See the `RDF 1.1 Concepts and Abstract
Syntax <https://www.w3.org/TR/rdf11-concepts/>`_ for more info.

RDF
The Resource Description Framework (RDF) is a framework for representing information in the Web. RDF data is
stored in graphs that are sets of subject-predicate-object triples, where the elements may be IRIs, blank nodes,
or datatyped literals. See the `OWL 2 Web Ontology Language
Document Overview <http://www.w3.org/TR/owl-overview/>`_ for more info.
Loading