Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(D
VALEFILES := $(shell find $(DOCS_DIR) -type f -name "*.md" -print)
VALEOPTS ?=
PYTHONVERSION = >=3.11,<3.14
SPHINXBUILD = "$(realpath .venv/bin/sphinx-build)"

# Add the following 'help' target to your Makefile
# And add help text after each target name starting with '\#\#'
Expand Down Expand Up @@ -96,7 +97,7 @@ rtd-prepare: ## Prepare environment on Read the Docs

.PHONY: rtd-pr-preview ## Build pull request previews on Read the Docs
rtd-pr-preview: rtd-prepare .venv/bin/python ## Build pull request preview on Read the Docs
cd $(DOCS_DIR) && $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) ${READTHEDOCS_OUTPUT}/html/
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) ${READTHEDOCS_OUTPUT}/html/
# /documentation builders


Expand Down
Binary file modified docs/docs/_static/favicon.ico
Binary file not shown.
55 changes: 2 additions & 53 deletions docs/docs/_static/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file.
13 changes: 6 additions & 7 deletions docs/docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
# -- Project information -----------------------------------------------------

project = "kitconcept.core"
author = "kitconcept GmbH"
trademark_name = "kitconcept"
author = "kitconcept, GmbH"
trademark_name = "kitconcept.core"
now = datetime.now()
year = str(now.year)
copyright = year
Expand Down Expand Up @@ -71,7 +71,6 @@
"sphinx_examples",
"sphinx_reredirects",
"sphinx_sitemap",
"sphinx_tippy",
"sphinxcontrib.httpdomain", # plone.restapi
"sphinxcontrib.httpexample", # plone.restapi
"sphinxcontrib.mermaid",
Expand All @@ -95,7 +94,7 @@
# Ignore file downloads
r"^/_static/",
# Ignore pages that require authentication
r"https://github.com/kitconcept/kitconceptcore/issues/new", # requires auth
r"https://github.com/kitconcept/kitconcept-core/issues/new", # requires auth
# Ignore github.com pages with anchors
r"https://github.com/.*#.*",
# Ignore other specific anchors
Expand Down Expand Up @@ -155,7 +154,7 @@
"icon_links": [
{
"name": "GitHub",
"url": "https://github.com/kitconcept/kitconceptcore",
"url": "https://github.com/kitconcept/kitconcept-core",
"icon": "fa-brands fa-square-github",
"type": "fontawesome",
"attributes": {
Expand All @@ -182,7 +181,7 @@
"navigation_with_keys": True,
"path_to_docs": "docs/docs",
"repository_branch": "main",
"repository_url": "https://github.com/kitconcept/kitconceptcore",
"repository_url": "https://github.com/kitconcept/kitconcept-core",
"search_bar_text": "Search",
"show_toc_level": 2,
"use_edit_page_button": True,
Expand Down Expand Up @@ -321,7 +320,7 @@
# -- Options for HTML help output -------------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = "kitconcept.coreDocumentation"
htmlhelp_basename = "kitconcept.core"


# -- Options for LaTeX output -------------------------------------------------
Expand Down
102 changes: 100 additions & 2 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,107 @@ myst:
# kitconcept.core

Welcome to the documentation for kitconcept.core!
Core setup for kitconcept GmbH distributions built on top of Plone

This scaffold provides a ready-to-use environment for creating comprehensive documentation for {term}`Plone` projects, based on {term}`Plone Sphinx Theme`.
`````{grid} 1 1 3 3
:gutter: 3 3 4 5

````{grid-item-card}
:columns: 12 12 12 12
:link: concepts/what-is-core
:link-type: doc
{octicon}`zap;1.5em;sd-text-info`
Get started
^^^
This part of the documentation describes what is kitconcept core and the reasoning behind.
+++
```{button-ref} concepts/what-is-core
:color: primary
:expand:
Go to Get started
```
````

````{grid-item-card}
:columns: 6 6 6 6
:link: https://volto-light-theme.readthedocs.io/
:link-type: url
{octicon}`person;1.5em;sd-text-info`
Volto Light Theme
^^^
This is the documentation specific to VLT features.
+++
```{button-link} https://volto-light-theme.readthedocs.io/
:color: primary
:expand:
Go to VLT docs
```
````

````{grid-item-card}
:columns: 6 6 6 6
:link: https://volto-light-theme.readthedocs.io/storybook/
:link-type: url
{octicon}`person-add;1.5em;sd-text-info`
VLT Storybook
^^^
This is the Storybook of VLT.
+++
```{button-ref} https://volto-light-theme.readthedocs.io/storybook/
:color: primary
:expand:
Go to VLT Storybook
```
````

````{grid-item-card}
:columns: 6 6 6 6
:link: https://kitconcept-intranet.readthedocs.io
:link-type: url
{octicon}`person-add;1.5em;sd-text-info`
Intranet distribution
^^^
This is the documentation specific to the kitconcept intranet distribution.
+++
```{button-ref} https://kitconcept-intranet.readthedocs.io
:color: primary
:expand:
Go to intranet docs
```
````

````{grid-item-card}
:columns: 6 6 6 6
:link: https://plone-intranet.kitconcept.dev
:link-type: url
{octicon}`person-add;1.5em;sd-text-info`
Intranet distribution dev demo site
^^^
This is the demo dev site (https://plone-intranet.kitconcept.dev).
+++
```{button-ref} https://plone-intranet.kitconcept.dev
:color: primary
:expand:
Go to intranet dev site
```
````

````{grid-item-card}
:columns: 6 6 6 6
:link: https://plone-components.readthedocs.io/
:link-type: url
{octicon}`person-add;1.5em;sd-text-info`
@plone/components Storybook
^^^
This is the Storybook (canary) of the @plone/components package.
+++
```{button-ref} https://plone-components.readthedocs.io/
:color: primary
:expand:
Go to @plone/components Storybook
```
````

`````

Built with Markedly Structured Text ({term}`MyST`), this environment supports rich formatting, directives, and extensions tailored for technical documentation.

Expand Down
2 changes: 1 addition & 1 deletion docs/pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[project]
name = "kitconcept_core_Documentation"
name = "kitconcept_core_docs"
description = "Core setup for kitconcept GmbH distributions built on top of Plone"
keywords = [
"kitconcept.core",
Expand Down
Loading