Skip to content

Commit

Permalink
Bring back first version of the documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
clebreto committed Sep 18, 2024
1 parent 1245347 commit 12de992
Show file tree
Hide file tree
Showing 45 changed files with 12,624 additions and 0 deletions.
36 changes: 36 additions & 0 deletions .github/workflows/sphinx.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: "Sphinx: Render docs"

on: push

jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: write
steps:

- name: Checkout development branch
uses: actions/checkout@v4
with:
ref: development

- name: Build Sphinx Docs
uses: ammaraskar/sphinx-action@master
with:
pre-build-command: "apt-get install doxygen -y"
build-command: "make html"
docs-folder: "docs/"

- name: Upload artifacts
uses: actions/upload-artifact@v4
with:
name: html-docs
path: docs/build/html/

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: github.ref == 'refs/heads/development'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/html

17 changes: 17 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Generated files for docs
generated/
bak/
build/

source/*
!source/**/*.rst
!source/**/*.py
!source/install.md
!source/Doxyfile


!source/rest_api/
!source/cli_ref/

!source/_templates/
!source/_static/
36 changes: 36 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile symbolic_links
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

# As a prerequisite create symbolic links to the subdirectories
# of /docs in the /docs/source directory. This is done to allow
# the Makefile to include all the MARKDOWN files in the /docs
# directory in the documentation rendered as HTML by Sphinx.
symbolic_links:
cd $(SOURCEDIR); \
echo "Creating a symbolic link to sub-dirs"; \
for dir in "getting started" "federation" "storage" "advanced"; do \
if [ ! -d "$$dir" ]; then \
ln -sfv "../$$dir" "$$dir"; \
echo "--- $$dir created"; \
else echo "--- $$dir already exists"; \
fi; \
done; \
cd -
29 changes: 29 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Corese documentation

The purpose of this page is to gather the documentation of Corese.

## corese-core

- [Getting Started With Corese-library](getting%20started/Getting%20Started%20With%20Corese-library.md)
- [Use Corese-library and RDF4J](rdf4j/RDF4J%20API%20in%20Corese.md)

## corese-server

- [Getting Started With Corese-server](getting%20started/Getting%20Started%20With%20Corese-server.md)
- [Use Corese-server with Python](corese-python/Corese-server%20with%20Python.md)

## corese-command

- [Getting Started With Corese-command](./getting%20started/Getting%20Started%20With%20Corese-command.md)

## corese-python

- [Getting Started With Corese-python](corese-python/Corese-library%20with%20Python.md)

## corese-plugin-storage

- [Configuring and Connecting to Different Storage Systems in Corese](storage/Configuring%20and%20Connecting%20to%20Different%20Storage%20Systems%20in%20Corese.md)

## Federated and Distributed Queries

- [Federated and Distributed Queries](federation/Federated%20and%20Distributed%20Queries.md)
Loading

0 comments on commit 12de992

Please sign in to comment.