Skip to content

Commit

Permalink
Attempt to add dev doc.
Browse files Browse the repository at this point in the history
  • Loading branch information
clebreto committed Sep 27, 2024
1 parent 7258582 commit 66fa2aa
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 13 deletions.
5 changes: 5 additions & 0 deletions .github/workflows/sphinx.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,11 @@ jobs:
sphinx-multiversion docs/source build/html -D 'exhale_args.containmentFolder=${sourcedir}/java_api'
chmod u+x docs/switcher_generator.sh
./docs/switcher_generator.sh build/html/switcher.json build/html/index.html
cd docs/source
doxygen
cd ../..
mkdir build/html/dev/
mv docs/build/html/* build/html/dev/
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
Expand Down
8 changes: 4 additions & 4 deletions docs/source/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -1287,7 +1287,7 @@ IGNORE_PREFIX =
# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
# The default value is: YES.

GENERATE_HTML = NO
GENERATE_HTML = YES

# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
Expand Down Expand Up @@ -2499,7 +2499,7 @@ HIDE_UNDOC_RELATIONS = YES
# set to NO
# The default value is: NO.

HAVE_DOT = NO
HAVE_DOT = YES

# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
# to run in parallel. When set to 0 doxygen will base this on the number of
Expand Down Expand Up @@ -2724,7 +2724,7 @@ DIR_GRAPH_MAX_DEPTH = 1
# The default value is: png.
# This tag requires that the tag HAVE_DOT is set to YES.

DOT_IMAGE_FORMAT = png
DOT_IMAGE_FORMAT = svg

# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
# enable generation of interactive SVG images that allow zooming and panning.
Expand All @@ -2736,7 +2736,7 @@ DOT_IMAGE_FORMAT = png
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.

INTERACTIVE_SVG = NO
INTERACTIVE_SVG = YES

# The DOT_PATH tag can be used to specify the path where the dot tool can be
# found. If left blank, it is assumed the dot tool can be found in the path.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Getting Started With corese-core
# Getting started with corese-core

This tutorial show how to use the corese-core framework through simple examples of the main features.
This tutorial show how to use the corese-core library through simple examples of the main features.
We assume a basic knowledge in Java programming and in semantic web.

The first part describes how to create, load and export a Graph.
Expand Down
14 changes: 7 additions & 7 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,18 +59,18 @@ Corese is a software platform implementing and extending the standards of the Se

Corese offers several interfaces
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* `corese-core <user_guide.html#corese-core>`_: Java library to process RDF data and use Corese features via an API.
* `corese-server <user_guide.html#corese-server>`_: Tool to easily create, configure and manage SPARQL endpoints.
* `corese-gui <install.html#corese-gui>`_: Graphical interface that allows an easy and visual use of Corese features.
* `corese-python (beta) <user_guide.html#corese-python>`_: Python wrapper for accessing and manipulating RDF data with Corese features using py4j.
* `corese-command (beta) <user_guide.html#corese-command>`_: Command Line Interface for Corese that allows users to interact with Corese features from the terminal.
* `corese-core <https://corese-stack.github.io/corese-core/>`_: Java library to process RDF data and use Corese features via an API.
* `corese-server <https://corese-stack.github.io/corese-server/>`_: Tool to easily create, configure and manage SPARQL endpoints.
* `corese-gui <https://corese-stack.github.io/corese-gui/>`_: Graphical interface that allows an easy and visual use of Corese features.
* `corese-python (beta) <https://corese-stack.github.io/corese-python/>`_: Python wrapper for accessing and manipulating RDF data with Corese features using py4j.
* `corese-command (beta) <https://corese-stack.github.io/corese-command/>`_: Command Line Interface for Corese that allows users to interact with Corese features from the terminal.

.. raw:: html

<h3>Contributions and discussions</h3>

.. _discussion forum: https://github.com/Wimmics/corese/discussions/
.. _issue reports: https://github.com/Wimmics/corese/issues/
.. _discussion forum: https://github.com/orgs/corese-stack/discussions
.. _issue reports: https://github.com/corese-stack/corese-core/issues
.. _pull requests: https://github.com/Wimmics/corese/pulls/

For support questions, comments, and any ideas for improvements you’d like to discuss, please use our `discussion forum`_. We welcome everyone to contribute to `issue reports`_, suggest new features, and create `pull requests`_.
Expand Down

0 comments on commit 66fa2aa

Please sign in to comment.