diff options
| author | Nicholas Car <nicholas.car@csiro.au> | 2020-03-15 22:22:26 +1000 |
|---|---|---|
| committer | Nicholas Car <nicholas.car@csiro.au> | 2020-03-15 22:22:26 +1000 |
| commit | f2fb50af5d1717837d6b568bb9be5ba6407b0a8e (patch) | |
| tree | b293b425c619127006641ec76f7d237db1b95cc0 | |
| parent | 833a9e02e8a4129eb8c28239bcd29cf43d80726a (diff) | |
| download | rdflib-f2fb50af5d1717837d6b568bb9be5ba6407b0a8e.tar.gz | |
added new logo to docs, change doc theme, rebuilt apidocs, altered index page content (added links to repo, further help)
| -rw-r--r-- | docs/_themes/armstrong/rtd-themes.conf | 65 | ||||
| -rw-r--r-- | docs/_themes/armstrong/theme-old.conf | 65 | ||||
| -rw-r--r-- | docs/_themes/armstrong/theme.conf | 48 | ||||
| -rw-r--r-- | docs/apidocs/modules.rst | 4 | ||||
| -rw-r--r-- | docs/apidocs/rdflib.extras.rst | 62 | ||||
| -rw-r--r-- | docs/apidocs/rdflib.plugins.parsers.rst | 107 | ||||
| -rw-r--r-- | docs/apidocs/rdflib.plugins.rst | 55 | ||||
| -rw-r--r-- | docs/apidocs/rdflib.plugins.serializers.rst | 97 | ||||
| -rw-r--r-- | docs/apidocs/rdflib.plugins.sparql.results.rst | 85 | ||||
| -rw-r--r-- | docs/apidocs/rdflib.plugins.sparql.rst | 149 | ||||
| -rw-r--r-- | docs/apidocs/rdflib.plugins.stores.rst | 71 | ||||
| -rw-r--r-- | docs/apidocs/rdflib.rst | 191 | ||||
| -rw-r--r-- | docs/apidocs/rdflib.tools.rst | 75 | ||||
| -rw-r--r-- | docs/conf.py | 4 | ||||
| -rw-r--r-- | docs/index.rst | 94 |
15 files changed, 582 insertions, 590 deletions
diff --git a/docs/_themes/armstrong/rtd-themes.conf b/docs/_themes/armstrong/rtd-themes.conf deleted file mode 100644 index 5930488d..00000000 --- a/docs/_themes/armstrong/rtd-themes.conf +++ /dev/null @@ -1,65 +0,0 @@ -[theme] -inherit = default -stylesheet = rtd.css -pygment_style = default -show_sphinx = False - -[options] -show_rtd = True - -white = #ffffff -almost_white = #f8f8f8 -barely_white = #f2f2f2 -dirty_white = #eeeeee -almost_dirty_white = #e6e6e6 -dirtier_white = #dddddd -lighter_gray = #cccccc -gray_a = #aaaaaa -gray_9 = #999999 -light_gray = #888888 -gray_7 = #777777 -gray = #666666 -dark_gray = #444444 -gray_2 = #222222 -black = #111111 -light_color = #e8ecef -light_medium_color = #DDEAF0 -medium_color = #8ca1af -medium_color_link = #86989b -medium_color_link_hover = #a6b8bb -dark_color = #465158 - -h1 = #000000 -h2 = #465158 -h3 = #6c818f - -link_color = #444444 -link_color_decoration = #CCCCCC - -medium_color_hover = #697983 -green_highlight = #8ecc4c - - -positive_dark = #609060 -positive_medium = #70a070 -positive_light = #e9ffe9 - -negative_dark = #900000 -negative_medium = #b04040 -negative_light = #ffe9e9 -negative_text = #c60f0f - -ruler = #abc - -viewcode_bg = #f4debf -viewcode_border = #ac9 - -highlight = #ffe080 - -code_background = #eeeeee - -background = #465158 -background_link = #ffffff -background_link_half = #ffffff -background_text = #eeeeee -background_text_link = #86989b diff --git a/docs/_themes/armstrong/theme-old.conf b/docs/_themes/armstrong/theme-old.conf new file mode 100644 index 00000000..c77da3a1 --- /dev/null +++ b/docs/_themes/armstrong/theme-old.conf @@ -0,0 +1,65 @@ +[theme] +inherit = default +stylesheet = rtd.css +pygment_style = default +show_sphinx = False + +[options] +show_rtd = True + +white = #ffffff +almost_white = #f8f8f8 +barely_white = #f2f2f2 +dirty_white = #eeeeee +almost_dirty_white = #e6e6e6 +dirtier_white = #DAC6AF +lighter_gray = #cccccc +gray_a = #aaaaaa +gray_9 = #999999 +light_gray = #888888 +gray_7 = #777777 +gray = #666666 +dark_gray = #444444 +gray_2 = #222222 +black = #111111 +light_color = #EDE4D8 +light_medium_color = #DDEAF0 +medium_color_link = #634320 +medium_color_link_hover = #261a0c +dark_color = rgba(160, 109, 52, 1.0) + +h1 = #1f3744 +h2 = #335C72 +h3 = #638fa6 + +link_color = #335C72 +link_color_decoration = #99AEB9 + +medium_color_hover = rgba(255, 255, 255, 0.25) +medium_color = rgba(255, 255, 255, 0.5) +green_highlight = #8ecc4c + + +positive_dark = rgba(51, 77, 0, 1.0) +positive_medium = rgba(102, 153, 0, 1.0) +positive_light = rgba(102, 153, 0, 0.1) + +negative_dark = rgba(51, 13, 0, 1.0) +negative_medium = rgba(204, 51, 0, 1.0) +negative_light = rgba(204, 51, 0, 0.1) +negative_text = #c60f0f + +ruler = #abc + +viewcode_bg = #f4debf +viewcode_border = #ac9 + +highlight = #ffe080 + +code_background = rgba(0, 0, 0, 0.075) + +background = rgba(135, 57, 34, 1.0) +background_link = rgba(212, 195, 172, 1.0) +background_link_half = rgba(212, 195, 172, 0.5) +background_text = rgba(212, 195, 172, 1.0) +background_text_link = rgba(171, 138, 93, 1.0) diff --git a/docs/_themes/armstrong/theme.conf b/docs/_themes/armstrong/theme.conf index c77da3a1..5930488d 100644 --- a/docs/_themes/armstrong/theme.conf +++ b/docs/_themes/armstrong/theme.conf @@ -12,7 +12,7 @@ almost_white = #f8f8f8 barely_white = #f2f2f2 dirty_white = #eeeeee almost_dirty_white = #e6e6e6 -dirtier_white = #DAC6AF +dirtier_white = #dddddd lighter_gray = #cccccc gray_a = #aaaaaa gray_9 = #999999 @@ -22,31 +22,31 @@ gray = #666666 dark_gray = #444444 gray_2 = #222222 black = #111111 -light_color = #EDE4D8 +light_color = #e8ecef light_medium_color = #DDEAF0 -medium_color_link = #634320 -medium_color_link_hover = #261a0c -dark_color = rgba(160, 109, 52, 1.0) +medium_color = #8ca1af +medium_color_link = #86989b +medium_color_link_hover = #a6b8bb +dark_color = #465158 -h1 = #1f3744 -h2 = #335C72 -h3 = #638fa6 +h1 = #000000 +h2 = #465158 +h3 = #6c818f -link_color = #335C72 -link_color_decoration = #99AEB9 +link_color = #444444 +link_color_decoration = #CCCCCC -medium_color_hover = rgba(255, 255, 255, 0.25) -medium_color = rgba(255, 255, 255, 0.5) +medium_color_hover = #697983 green_highlight = #8ecc4c -positive_dark = rgba(51, 77, 0, 1.0) -positive_medium = rgba(102, 153, 0, 1.0) -positive_light = rgba(102, 153, 0, 0.1) +positive_dark = #609060 +positive_medium = #70a070 +positive_light = #e9ffe9 -negative_dark = rgba(51, 13, 0, 1.0) -negative_medium = rgba(204, 51, 0, 1.0) -negative_light = rgba(204, 51, 0, 0.1) +negative_dark = #900000 +negative_medium = #b04040 +negative_light = #ffe9e9 negative_text = #c60f0f ruler = #abc @@ -56,10 +56,10 @@ viewcode_border = #ac9 highlight = #ffe080 -code_background = rgba(0, 0, 0, 0.075) +code_background = #eeeeee -background = rgba(135, 57, 34, 1.0) -background_link = rgba(212, 195, 172, 1.0) -background_link_half = rgba(212, 195, 172, 0.5) -background_text = rgba(212, 195, 172, 1.0) -background_text_link = rgba(171, 138, 93, 1.0) +background = #465158 +background_link = #ffffff +background_link_half = #ffffff +background_text = #eeeeee +background_text_link = #86989b diff --git a/docs/apidocs/modules.rst b/docs/apidocs/modules.rst index 6db120d1..0b1fa9e2 100644 --- a/docs/apidocs/modules.rst +++ b/docs/apidocs/modules.rst @@ -1,5 +1,5 @@ -rdflib API docs -=============== +rdflib +====== .. toctree:: :maxdepth: 10 diff --git a/docs/apidocs/rdflib.extras.rst b/docs/apidocs/rdflib.extras.rst index 3da6f545..7cd472bb 100644 --- a/docs/apidocs/rdflib.extras.rst +++ b/docs/apidocs/rdflib.extras.rst @@ -1,36 +1,46 @@ -extras Package -============== +rdflib.extras package +===================== -:mod:`extras` Package ---------------------- +Submodules +---------- -.. automodule:: rdflib.extras - :members: - :undoc-members: - :show-inheritance: - -:mod:`cmdlineutils` Module --------------------------- +rdflib.extras.cmdlineutils module +--------------------------------- .. automodule:: rdflib.extras.cmdlineutils - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -:mod:`describer` Module ------------------------ +rdflib.extras.describer module +------------------------------ .. automodule:: rdflib.extras.describer - :members: - :undoc-members: - :show-inheritance: - :exclude-members: __dict__,__weakref__ + :members: + :undoc-members: + :show-inheritance: + +rdflib.extras.external\_graph\_libs module +------------------------------------------ + +.. automodule:: rdflib.extras.external_graph_libs + :members: + :undoc-members: + :show-inheritance: -:mod:`infixowl` Module ----------------------- +rdflib.extras.infixowl module +----------------------------- .. automodule:: rdflib.extras.infixowl - :members: - :undoc-members: - :show-inheritance: - :exclude-members: __dict__,__weakref__ + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: rdflib.extras + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/rdflib.plugins.parsers.rst b/docs/apidocs/rdflib.plugins.parsers.rst index 9428ad47..e3ba5ff3 100644 --- a/docs/apidocs/rdflib.plugins.parsers.rst +++ b/docs/apidocs/rdflib.plugins.parsers.rst @@ -1,85 +1,70 @@ -parsers Package -=============== +rdflib.plugins.parsers package +============================== -:mod:`parsers` Package ----------------------- +Submodules +---------- -.. automodule:: rdflib.plugins.parsers - :members: - :undoc-members: - :show-inheritance: - -:mod:`hturtle` Module ---------------------- - -.. automodule:: rdflib.plugins.parsers.hturtle - :members: - :undoc-members: - :show-inheritance: - -:mod:`notation3` Module ------------------------ +rdflib.plugins.parsers.notation3 module +--------------------------------------- .. automodule:: rdflib.plugins.parsers.notation3 - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -:mod:`nquads` Module --------------------- +rdflib.plugins.parsers.nquads module +------------------------------------ .. automodule:: rdflib.plugins.parsers.nquads - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -:mod:`nt` Module ----------------- +rdflib.plugins.parsers.nt module +-------------------------------- .. automodule:: rdflib.plugins.parsers.nt - :members: - :undoc-members: - :show-inheritance: - :exclude-members: __dict__,__weakref__ + :members: + :undoc-members: + :show-inheritance: -:mod:`ntriples` Module ----------------------- +rdflib.plugins.parsers.ntriples module +-------------------------------------- .. automodule:: rdflib.plugins.parsers.ntriples - :members: - :undoc-members: - :show-inheritance: - :exclude-members: __dict__,__weakref__ + :members: + :undoc-members: + :show-inheritance: -:mod:`rdfxml` Module --------------------- +rdflib.plugins.parsers.rdfxml module +------------------------------------ .. automodule:: rdflib.plugins.parsers.rdfxml - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -:mod:`structureddata` Module ----------------------------- +rdflib.plugins.parsers.trig module +---------------------------------- -.. automodule:: rdflib.plugins.parsers.structureddata - :members: - :undoc-members: - :show-inheritance: +.. automodule:: rdflib.plugins.parsers.trig + :members: + :undoc-members: + :show-inheritance: -:mod:`trix` Module ------------------- +rdflib.plugins.parsers.trix module +---------------------------------- .. automodule:: rdflib.plugins.parsers.trix - :members: - :undoc-members: - :show-inheritance: - -Subpackages ------------ + :members: + :undoc-members: + :show-inheritance: -.. toctree:: - rdflib.plugins.parsers.pyMicrodata - rdflib.plugins.parsers.pyRdfa +Module contents +--------------- +.. automodule:: rdflib.plugins.parsers + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/rdflib.plugins.rst b/docs/apidocs/rdflib.plugins.rst index 6d45026f..aa93c1bd 100644 --- a/docs/apidocs/rdflib.plugins.rst +++ b/docs/apidocs/rdflib.plugins.rst @@ -1,37 +1,40 @@ -plugins Package -=============== +rdflib.plugins package +====================== -:mod:`plugins` Package ----------------------- +Subpackages +----------- -.. automodule:: rdflib.plugins - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + + rdflib.plugins.parsers + rdflib.plugins.serializers + rdflib.plugins.sparql + rdflib.plugins.stores + +Submodules +---------- -:mod:`memory` Module --------------------- +rdflib.plugins.memory module +---------------------------- .. automodule:: rdflib.plugins.memory - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -:mod:`sleepycat` Module ------------------------ +rdflib.plugins.sleepycat module +------------------------------- .. automodule:: rdflib.plugins.sleepycat - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -Subpackages ------------ -.. toctree:: - - rdflib.plugins.parsers - rdflib.plugins.serializers - rdflib.plugins.sparql - rdflib.plugins.stores +Module contents +--------------- +.. automodule:: rdflib.plugins + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/rdflib.plugins.serializers.rst b/docs/apidocs/rdflib.plugins.serializers.rst index c89309dd..c5ce952c 100644 --- a/docs/apidocs/rdflib.plugins.serializers.rst +++ b/docs/apidocs/rdflib.plugins.serializers.rst @@ -1,67 +1,78 @@ -serializers Package -=================== +rdflib.plugins.serializers package +================================== -:mod:`n3` Module ----------------- +Submodules +---------- + +rdflib.plugins.serializers.n3 module +------------------------------------ .. automodule:: rdflib.plugins.serializers.n3 - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -:mod:`nquads` Module --------------------- +rdflib.plugins.serializers.nquads module +---------------------------------------- .. automodule:: rdflib.plugins.serializers.nquads - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -:mod:`nt` Module ----------------- +rdflib.plugins.serializers.nt module +------------------------------------ .. automodule:: rdflib.plugins.serializers.nt - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -:mod:`rdfxml` Module --------------------- +rdflib.plugins.serializers.rdfxml module +---------------------------------------- .. automodule:: rdflib.plugins.serializers.rdfxml - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -:mod:`trig` Module ------------------- +rdflib.plugins.serializers.trig module +-------------------------------------- .. automodule:: rdflib.plugins.serializers.trig - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -:mod:`trix` Module ------------------- +rdflib.plugins.serializers.trix module +-------------------------------------- .. automodule:: rdflib.plugins.serializers.trix - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -:mod:`turtle` Module --------------------- +rdflib.plugins.serializers.turtle module +---------------------------------------- .. automodule:: rdflib.plugins.serializers.turtle - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -:mod:`xmlwriter` Module ------------------------ +rdflib.plugins.serializers.xmlwriter module +------------------------------------------- .. automodule:: rdflib.plugins.serializers.xmlwriter - :members: - :undoc-members: - :show-inheritance: - :exclude-members: __dict__,__weakref__ + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: rdflib.plugins.serializers + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/rdflib.plugins.sparql.results.rst b/docs/apidocs/rdflib.plugins.sparql.results.rst index 41d632ff..b9ff9310 100644 --- a/docs/apidocs/rdflib.plugins.sparql.results.rst +++ b/docs/apidocs/rdflib.plugins.sparql.results.rst @@ -1,51 +1,70 @@ -results Package -=============== +rdflib.plugins.sparql.results package +===================================== -:mod:`csvresults` Module ------------------------- +Submodules +---------- + +rdflib.plugins.sparql.results.csvresults module +----------------------------------------------- .. automodule:: rdflib.plugins.sparql.results.csvresults - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -:mod:`jsonlayer` Module ------------------------ +rdflib.plugins.sparql.results.graph module +------------------------------------------ -.. automodule:: rdflib.plugins.sparql.results.jsonlayer - :members: - :undoc-members: - :show-inheritance: +.. automodule:: rdflib.plugins.sparql.results.graph + :members: + :undoc-members: + :show-inheritance: -:mod:`jsonresults` Module -------------------------- +rdflib.plugins.sparql.results.jsonresults module +------------------------------------------------ .. automodule:: rdflib.plugins.sparql.results.jsonresults - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -:mod:`rdfresults` Module ------------------------- +rdflib.plugins.sparql.results.rdfresults module +----------------------------------------------- .. automodule:: rdflib.plugins.sparql.results.rdfresults - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -:mod:`tsvresults` Module ------------------------- +rdflib.plugins.sparql.results.tsvresults module +----------------------------------------------- .. automodule:: rdflib.plugins.sparql.results.tsvresults - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: + +rdflib.plugins.sparql.results.txtresults module +----------------------------------------------- + +.. automodule:: rdflib.plugins.sparql.results.txtresults + :members: + :undoc-members: + :show-inheritance: -:mod:`xmlresults` Module ------------------------- +rdflib.plugins.sparql.results.xmlresults module +----------------------------------------------- .. automodule:: rdflib.plugins.sparql.results.xmlresults - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- +.. automodule:: rdflib.plugins.sparql.results + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/rdflib.plugins.sparql.rst b/docs/apidocs/rdflib.plugins.sparql.rst index 0985fd41..768f4a1d 100644 --- a/docs/apidocs/rdflib.plugins.sparql.rst +++ b/docs/apidocs/rdflib.plugins.sparql.rst @@ -1,116 +1,109 @@ -sparql Package -============== +rdflib.plugins.sparql package +============================= -:mod:`sparql` Package ---------------------- +Subpackages +----------- -.. automodule:: rdflib.plugins.sparql - :members: - :undoc-members: - :show-inheritance: +.. toctree:: -:mod:`aggregates` Module ------------------------- + rdflib.plugins.sparql.results -.. automodule:: rdflib.plugins.sparql.aggregates - :members: - :undoc-members: - :show-inheritance: +Submodules +---------- -:mod:`algebra` Module ---------------------- +rdflib.plugins.sparql.aggregates module +--------------------------------------- -.. automodule:: rdflib.plugins.sparql.algebra - :members: - :undoc-members: - :show-inheritance: +.. automodule:: rdflib.plugins.sparql.aggregates + :members: + :undoc-members: + :show-inheritance: -:mod:`compat` Module --------------------- +rdflib.plugins.sparql.algebra module +------------------------------------ -.. automodule:: rdflib.plugins.sparql.compat - :members: - :undoc-members: - :show-inheritance: +.. automodule:: rdflib.plugins.sparql.algebra + :members: + :undoc-members: + :show-inheritance: -:mod:`datatypes` Module ------------------------ +rdflib.plugins.sparql.datatypes module +-------------------------------------- .. automodule:: rdflib.plugins.sparql.datatypes - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -:mod:`evaluate` Module ----------------------- +rdflib.plugins.sparql.evaluate module +------------------------------------- .. automodule:: rdflib.plugins.sparql.evaluate - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -:mod:`evalutils` Module ------------------------ +rdflib.plugins.sparql.evalutils module +-------------------------------------- .. automodule:: rdflib.plugins.sparql.evalutils - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -:mod:`operators` Module ------------------------ +rdflib.plugins.sparql.operators module +-------------------------------------- .. automodule:: rdflib.plugins.sparql.operators - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -:mod:`parser` Module --------------------- +rdflib.plugins.sparql.parser module +----------------------------------- .. automodule:: rdflib.plugins.sparql.parser - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -:mod:`parserutils` Module -------------------------- +rdflib.plugins.sparql.parserutils module +---------------------------------------- .. automodule:: rdflib.plugins.sparql.parserutils - :members: - :undoc-members: - :show-inheritance: - :exclude-members: __dict__,__weakref__ + :members: + :undoc-members: + :show-inheritance: -:mod:`processor` Module ------------------------ +rdflib.plugins.sparql.processor module +-------------------------------------- .. automodule:: rdflib.plugins.sparql.processor - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -:mod:`sparql` Module --------------------- +rdflib.plugins.sparql.sparql module +----------------------------------- .. automodule:: rdflib.plugins.sparql.sparql - :members: - :undoc-members: - :show-inheritance: - :exclude-members: __dict__,__weakref__ + :members: + :undoc-members: + :show-inheritance: -:mod:`update` Module --------------------- +rdflib.plugins.sparql.update module +----------------------------------- .. automodule:: rdflib.plugins.sparql.update - :members: - :undoc-members: - :show-inheritance: - -Subpackages ------------ + :members: + :undoc-members: + :show-inheritance: -.. toctree:: - rdflib.plugins.sparql.results +Module contents +--------------- +.. automodule:: rdflib.plugins.sparql + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/rdflib.plugins.stores.rst b/docs/apidocs/rdflib.plugins.stores.rst index 89f4506a..7367f47b 100644 --- a/docs/apidocs/rdflib.plugins.stores.rst +++ b/docs/apidocs/rdflib.plugins.stores.rst @@ -1,45 +1,54 @@ -stores Package -============== +rdflib.plugins.stores package +============================= -:mod:`stores` Package ---------------------- +Submodules +---------- -.. automodule:: rdflib.plugins.stores - :members: - :undoc-members: - :show-inheritance: - -:mod:`auditable` Module ------------------------ +rdflib.plugins.stores.auditable module +-------------------------------------- .. automodule:: rdflib.plugins.stores.auditable - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -:mod:`concurrent` Module ------------------------- +rdflib.plugins.stores.concurrent module +--------------------------------------- .. automodule:: rdflib.plugins.stores.concurrent - :members: - :undoc-members: - :show-inheritance: - :exclude-members: __dict__,__weakref__ + :members: + :undoc-members: + :show-inheritance: -:mod:`regexmatching` Module ---------------------------- +rdflib.plugins.stores.regexmatching module +------------------------------------------ .. automodule:: rdflib.plugins.stores.regexmatching - :members: - :undoc-members: - :show-inheritance: - :exclude-members: __dict__,__weakref__ + :members: + :undoc-members: + :show-inheritance: + +rdflib.plugins.stores.sparqlconnector module +-------------------------------------------- + +.. automodule:: rdflib.plugins.stores.sparqlconnector + :members: + :undoc-members: + :show-inheritance: -:mod:`sparqlstore` Module -------------------------- +rdflib.plugins.stores.sparqlstore module +---------------------------------------- .. automodule:: rdflib.plugins.stores.sparqlstore - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: rdflib.plugins.stores + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/rdflib.rst b/docs/apidocs/rdflib.rst index f279cb03..99fa6132 100644 --- a/docs/apidocs/rdflib.rst +++ b/docs/apidocs/rdflib.rst @@ -1,180 +1,159 @@ -rdflib Package +rdflib package ============== -:mod:`rdflib` Package ---------------------- +Subpackages +----------- + +.. toctree:: + + rdflib.extras + rdflib.plugins + rdflib.tools -.. automodule:: rdflib.__init__ - :members: NORMALIZE_LITERALS, DAWG_LITERAL_COLLATION - :show-inheritance: +Submodules +---------- -:mod:`collection` Module +rdflib.collection module ------------------------ .. automodule:: rdflib.collection - :members: - :undoc-members: - :show-inheritance: - :exclude-members: __dict__,__weakref__ + :members: + :undoc-members: + :show-inheritance: -:mod:`compare` Module +rdflib.compare module --------------------- .. automodule:: rdflib.compare - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -:mod:`compat` Module +rdflib.compat module -------------------- .. automodule:: rdflib.compat - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -:mod:`events` Module +rdflib.events module -------------------- .. automodule:: rdflib.events - :members: - :undoc-members: - :show-inheritance: - :exclude-members: __dict__,__weakref__ + :members: + :undoc-members: + :show-inheritance: -:mod:`exceptions` Module +rdflib.exceptions module ------------------------ .. automodule:: rdflib.exceptions - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -:mod:`graph` Module +rdflib.graph module ------------------- .. automodule:: rdflib.graph - :members: - :undoc-members: - :show-inheritance: - :exclude-members: __dict__,__weakref__ + :members: + :undoc-members: + :show-inheritance: -:mod:`namespace` Module +rdflib.namespace module ----------------------- .. automodule:: rdflib.namespace - :members: - :undoc-members: - :show-inheritance: - :exclude-members: __dict__,__weakref__ + :members: + :undoc-members: + :show-inheritance: -:mod:`parser` Module +rdflib.parser module -------------------- .. automodule:: rdflib.parser - :members: - :undoc-members: - :show-inheritance: - :exclude-members: __dict__,__weakref__ + :members: + :undoc-members: + :show-inheritance: -:mod:`paths` Module +rdflib.paths module ------------------- .. automodule:: rdflib.paths - :members: - :undoc-members: - :show-inheritance: - :exclude-members: __dict__,__weakref__ + :members: + :undoc-members: + :show-inheritance: -:mod:`plugin` Module +rdflib.plugin module -------------------- .. automodule:: rdflib.plugin - :members: - :undoc-members: - :show-inheritance: - :exclude-members: __dict__,__weakref__ - -:mod:`py3compat` Module ------------------------ + :members: + :undoc-members: + :show-inheritance: -.. automodule:: rdflib.py3compat - :members: - :undoc-members: - :show-inheritance: - -:mod:`query` Module +rdflib.query module ------------------- .. automodule:: rdflib.query - :members: - :undoc-members: - :show-inheritance: - :exclude-members: __dict__,__weakref__ - - .. autoclass:: ResultRow - :members: + :members: + :undoc-members: + :show-inheritance: - -:mod:`resource` Module +rdflib.resource module ---------------------- .. automodule:: rdflib.resource - :members: - :undoc-members: - :show-inheritance: - :exclude-members: __dict__,__weakref__ + :members: + :undoc-members: + :show-inheritance: -:mod:`serializer` Module +rdflib.serializer module ------------------------ .. automodule:: rdflib.serializer - :members: - :undoc-members: - :show-inheritance: - :exclude-members: __dict__,__weakref__ + :members: + :undoc-members: + :show-inheritance: -:mod:`store` Module +rdflib.store module ------------------- .. automodule:: rdflib.store - :members: - :undoc-members: - :show-inheritance: - :exclude-members: __dict__,__weakref__ + :members: + :undoc-members: + :show-inheritance: -:mod:`term` Module +rdflib.term module ------------------ .. automodule:: rdflib.term - :members: - :undoc-members: - :show-inheritance: - :exclude-members: __dict__,__weakref__ - + :members: + :undoc-members: + :show-inheritance: -:mod:`util` Module +rdflib.util module ------------------ .. automodule:: rdflib.util - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -:mod:`void` Module +rdflib.void module ------------------ .. automodule:: rdflib.void - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -Subpackages ------------ - -.. toctree:: - rdflib.extras - rdflib.plugins - rdflib.tools +Module contents +--------------- +.. automodule:: rdflib + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/apidocs/rdflib.tools.rst b/docs/apidocs/rdflib.tools.rst index 856991cc..eaf8edf8 100644 --- a/docs/apidocs/rdflib.tools.rst +++ b/docs/apidocs/rdflib.tools.rst @@ -1,55 +1,54 @@ -tools Package -============= +rdflib.tools package +==================== -These commandline-tools are installed into :samp:`{INSTALL_PREFIX}/bin` by setuptools. +Submodules +---------- -:mod:`tools` Package ---------------------- - -.. automodule:: rdflib.tools - :members: - :undoc-members: - :show-inheritance: - - -:mod:`csv2rdf` Module ---------------------- +rdflib.tools.csv2rdf module +--------------------------- .. automodule:: rdflib.tools.csv2rdf - :members: - :undoc-members: - :show-inheritance: - :exclude-members: __dict__,__weakref__ + :members: + :undoc-members: + :show-inheritance: -:mod:`graphisomorphism` Module ------------------------------- +rdflib.tools.graphisomorphism module +------------------------------------ .. automodule:: rdflib.tools.graphisomorphism - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -:mod:`rdf2dot` Module ---------------------- +rdflib.tools.rdf2dot module +--------------------------- .. automodule:: rdflib.tools.rdf2dot - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -:mod:`rdfpipe` Module ---------------------- +rdflib.tools.rdfpipe module +--------------------------- .. automodule:: rdflib.tools.rdfpipe - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -:mod:`rdfs2dot` Module ----------------------- +rdflib.tools.rdfs2dot module +---------------------------- .. automodule:: rdflib.tools.rdfs2dot - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: rdflib.tools + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/conf.py b/docs/conf.py index 814e1f54..384abadb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -134,12 +134,12 @@ html_theme_path = ["_themes", ] # The name of an image file (relative to this directory) to place at the top # of the sidebar. #html_logo = None -html_logo = '_static/logo.svg' +html_logo = '_static/rdflib.png' # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -#html_favicon = None +html_favicon = '_static/rdflib.ico' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/docs/index.rst b/docs/index.rst index 66d88e16..ac9820f7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,20 +4,32 @@ rdflib |release| ================ -RDFLib is a pure Python package for working with `RDF <http://www.w3.org/RDF/>`_. RDFLib contains useful APIs for working with RDF, including: +RDFLib is a pure Python package for working with `RDF <http://www.w3.org/RDF/>`_. RDFLib contains useful APIs for +working with RDF, including: -* parsers and serializers for RDF/XML, N3, NTriples, N-Quads, Turtle, TriX, RDFa and Microdata. +* **Parsers & Serializers** -* a Graph interface which can be backed by a number of store implementations. + * for RDF/XML, N3, NTriples, N-Quads, Turtle, TriX, RDFa and Microdata + * and JSON-LD, via a plugin module -* store implementations for in memory storage and persistent storage on top of the Berkeley DB. +* **Store implementations** + + * for in-memory and persistent RDF storage - Berkeley DB + +* **a graph interface** + + * to a single graph + * or a conjunctive graph (multiple named graphs) + * or a dataset of graphs + +* **SPARQL 1.1 implementation** + + * supporting both Queries and Updates -* a SPARQL 1.1 implementation - supporting SPARQL 1.1 Queries and Update statements. Getting started --------------- - -If you have never used RDFLib, the following will help get you started +If you have never used RDFLib, the following will help get you started: .. toctree:: :maxdepth: 1 @@ -27,14 +39,12 @@ If you have never used RDFLib, the following will help get you started intro_to_creating_rdf intro_to_graphs intro_to_sparql - utilities + Examples <apidocs/examples> - RDFLib examples <apidocs/examples> In depth -------- - If you are familiar with RDF and are looking for details on how RDFLib handles RDF, these are for you. .. toctree:: @@ -44,37 +54,31 @@ If you are familiar with RDF and are looking for details on how RDFLib handles R namespaces_and_bindings persistence merging - - upgrade3to4 - upgrade2to3 - faq Reference --------- - The nitty-gritty details of everything. -.. toctree:: - :maxdepth: 2 - - plugins +API reference: .. toctree:: :maxdepth: 1 apidocs/modules -* :ref:`genindex` -* :ref:`modindex` - +.. toctree:: + :maxdepth: 2 + + plugins +.. * :ref:`genindex` +.. * :ref:`modindex` For developers -------------- - .. toctree:: :maxdepth: 1 @@ -83,42 +87,22 @@ For developers univrdfstore persisting_n3_terms +Developers might also like to join rdflib's dev mailing list: `<https://groups.google.com/group/rdflib-dev>`__ +The Code +-------- +The rdflib code is hosted on GitHub at `<https://github.com/RDFLib/rdflib>`__ where you lodge Issues and also Pull +Requests to help improve this community project! -Indices and tables ------------------- - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` +The RDFlib organisation on GitHub at `<https://github.com/RDFLib>`__ maintains this package and a number of other RDF +and related packaged that you might also find useful. -.. glossary:: - functional properties - - A functional property is a property that can - have only one (unique) value y for each instance x, i.e. there - cannot be two distinct values y1 and y2 such that the pairs - (x,y1) and (x,y2) are both instances of this - property. -- http://www.w3.org/TR/owl-ref/#FunctionalProperty-def +Further help +----------- +If you would like more help with using rdflib, please post a question using the tag [rdflib] on StackOverflow. A list of +existing [rdflib] tagged questions is there at: - graph - An RDF graph is a set of RDF triples. The set of nodes of an RDF graph - is the set of subjects and objects of triples in the graph. - - named graph - Named Graphs allow multiple RDF graphs to exist within a single - document/repository. They can be referred to with URIs. Named graphs allow queries across multiple domains. - -- http://www.w3.org/2004/03/trix/ +* `<https://stackoverflow.com/questions/tagged/rdflib>`__ - transitivity - A property is transitive: - - if whenever an element ``a`` is related to an element - ``b``, and ``b`` is in turn related to an element ``c``, - then ``a`` is also related to ``c``. -- - http://en.wikipedia.org/wiki/Transitive_relation - - Standard examples include ``rdfs:subClassOf`` or greater-than - |
