From dc7f28de6bb490920f247b6a821a25e1e88fc121 Mon Sep 17 00:00:00 2001 From: ben Date: Tue, 10 Jan 2023 20:43:33 +0100 Subject: [PATCH 01/18] Create landing page based on docs --- .gitignore | 1 + doc/landing-page/Makefile | 20 +++ doc/landing-page/conf.py | 198 +++++++++++++++++++++++++ doc/landing-page/index.rst | 23 +++ doc/landing-page/make.bat | 36 +++++ doc/landing-page/static/css/custom.css | 110 ++++++++++++++ 6 files changed, 388 insertions(+) create mode 100644 doc/landing-page/Makefile create mode 100644 doc/landing-page/conf.py create mode 100644 doc/landing-page/index.rst create mode 100644 doc/landing-page/make.bat create mode 100644 doc/landing-page/static/css/custom.css diff --git a/.gitignore b/.gitignore index 6f25c30c3..ec2243c97 100644 --- a/.gitignore +++ b/.gitignore @@ -8,3 +8,4 @@ dist coverage.xml example/Tests/ build +doc/landing-page/_build \ No newline at end of file diff --git a/doc/landing-page/Makefile b/doc/landing-page/Makefile new file mode 100644 index 000000000..05cb6a637 --- /dev/null +++ b/doc/landing-page/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = DFetch +SOURCEDIR = . +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 + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/doc/landing-page/conf.py b/doc/landing-page/conf.py new file mode 100644 index 000000000..5752f37c7 --- /dev/null +++ b/doc/landing-page/conf.py @@ -0,0 +1,198 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# Documentation build configuration file, created by +# sphinx-quickstart on Thu Jan 11 16:03:16 2018. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os + +from dfetch import __version__ + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +# extensions = ['sphinx.ext.autodoc', 'sphinx_autodoc_annotation', 'sphinx.ext.viewcode', 'sphinx.ext.napoleon', 'sphinxarg.ext', 'sphinx.ext.autosectionlabel'] +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.viewcode", + "sphinx.ext.napoleon", + "sphinxarg.ext", + "sphinx.ext.autosectionlabel", + "plantweb.directive", + "sphinxcontrib.asciinema", +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = ".rst" + +# The master toctree document. +master_doc = "index" + +# General information about the project. +project = "Dfetch" +copyright = "2021, Dfetch-org" +author = "DFetch" + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = __version__ +# The full version, including alpha/beta/rc tags. +release = "" + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = "en" + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "venv"] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = "sphinx" + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = "alabaster" + +html_css_files = [ + "css/custom.css", +] + +html_logo = "../images/dfetch_logo.png" + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +html_theme_options = { + "show_powered_by": False, + "github_user": "dfetch-org", + "github_repo": "dfetch", + "github_banner": True, + "show_related": True, + "note_bg": "#FFF59C", + 'nosidebar': True, +} + +# 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, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ["static"] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +html_sidebars = { + "**": [ + "about.html", + "searchbox.html", + "navigation.html", + "relations.html", # needs 'show_related': True theme option to display + ] +} + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = "dfetchdoc" + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, "dfetch.tex", "Dfetch Documentation", "Dfetch", "manual"), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [(master_doc, "dfetch", "Dfetch Documentation", [author], 1)] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ( + master_doc, + "dfetch", + "Dfetch Documentation", + author, + "Dfetch", + "One line description of project.", + "Miscellaneous", + ), +] + +# Options for asciicasts +sphinxcontrib_asciinema_defaults = { + "theme": "monokai", + "preload": 1, + "font-size": "15px", + "speed": 1.5, + "loop": False, + "autoplay": True, +} diff --git a/doc/landing-page/index.rst b/doc/landing-page/index.rst new file mode 100644 index 000000000..b2a085874 --- /dev/null +++ b/doc/landing-page/index.rst @@ -0,0 +1,23 @@ +.. Dfetch documentation master file + +.. image:: ../images/dfetch_header.png + :height: 203 + :width: 571 + :align: center + +.. asciinema:: ../asciicasts/basic.cast + + +Dfetch +====== + +What is Dfetch? +--------------- + +**Dfetch is source-only no-hassle project-dependency aggregator.** + +We needed a dependency manager that was flexible enough to retrieve dependencies as plain text +from various sources. `svn externals`, `git submodules` and `git subtrees` solve a similar +problem, but not in a vcs agnostic way or completely user friendly way. +We want self-contained code repositories without any hassle for end-users. +Dfetch must promote upstreaming changes, but allow for local customizations. diff --git a/doc/landing-page/make.bat b/doc/landing-page/make.bat new file mode 100644 index 000000000..9807c5ed0 --- /dev/null +++ b/doc/landing-page/make.bat @@ -0,0 +1,36 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build +set SPHINXPROJ=DFetch + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% + +:end +popd diff --git a/doc/landing-page/static/css/custom.css b/doc/landing-page/static/css/custom.css new file mode 100644 index 000000000..c502c39b1 --- /dev/null +++ b/doc/landing-page/static/css/custom.css @@ -0,0 +1,110 @@ +@import url("https://fonts.googleapis.com/css?family=Roboto:100,300,300i,400,500,700,900"); + +.sphinxsidebar .caption-text { + font-size: 130%; +} + +.logo { + width: 100%; +} + +.sphinxsidebarwrapper .internal, +.sphinxsidebarwrapper .external { + font-weight: 300; +} + +body { + font-family: Roboto; +} + +h1, +h2, +h3, +h4, +h5, +h6 { + font-family: Roboto !important; + font-weight: 300 !important; +} + +.toctree-l1 { + padding-bottom: 0.5em; +} + +.body p, +.body dd, +.body li { + font-family: Roboto; + font-size: 1em; + font-weight: 300; + line-height: 2; + text-align: justify; +} + +.search { + margin-bottom: 1em; +} + +.sphinxsidebarwrapper ul { + margin-bottom: 1em; +} + +.sphinxsidebar input[type="submit"] { + font-family: "Roboto", serif; +} + +.caption { + margin-top: 1em; +} + +.caption-text { + font-weight: 500; +} + +.sphinxsidebarwrapper .logo-name { + display: none; +} + +.sphinxsidebarwrapper .logo { + margin-bottom: 2em; +} + +img { + height: auto; + max-width: 100%; +} + +div.admonition { + border: none; + border-radius: 0; + box-shadow: 0 2px 2px 0 rgba(0, 0, 0, 0.14), 0 1px 5px 0 rgba(0, 0, 0, 0.12), + 0 3px 1px -2px rgba(0, 0, 0, 0.2); + font-family: Roboto; + padding: 2em; + position: relative; + transition: box-shadow 0.25s; +} + +div.admonition p.admonition-title { + font-family: "Roboto", serif; + font-weight: 300; + margin: 0 0 5px 0; +} + +div.admonition p { + font-weight: 300; + margin-top: 1em; +} + +.admonition a { + font-weight: 300; +} + +strong { + font-weight: 400; +} + +.pre { + padding-left: 0.2em; + padding-right: 0.2em; +} From 99163e7250666a4292e43dd306916fe5fce1f15d Mon Sep 17 00:00:00 2001 From: ben Date: Tue, 10 Jan 2023 22:54:55 +0100 Subject: [PATCH 02/18] Update landing page --- dfetch.yaml | 4 +- doc/landing-page/conf.py | 3 +- doc/landing-page/index.rst | 121 +++++++++++++++++++++++++++++++++---- pyproject.toml | 1 + 4 files changed, 114 insertions(+), 15 deletions(-) diff --git a/dfetch.yaml b/dfetch.yaml index 442679819..f1a42f29f 100644 --- a/dfetch.yaml +++ b/dfetch.yaml @@ -1,7 +1,7 @@ manifest: - version: 0.0 # DFetch Module syntax version + version: 0.0 - remotes: # declare common sources in one place + remotes: - name: github url-base: https://github.com/ diff --git a/doc/landing-page/conf.py b/doc/landing-page/conf.py index 5752f37c7..5f38e76a9 100644 --- a/doc/landing-page/conf.py +++ b/doc/landing-page/conf.py @@ -39,6 +39,7 @@ "sphinx.ext.autosectionlabel", "plantweb.directive", "sphinxcontrib.asciinema", + "sphinx_design" ] # Add any paths that contain templates here, relative to this directory. @@ -191,7 +192,7 @@ sphinxcontrib_asciinema_defaults = { "theme": "monokai", "preload": 1, - "font-size": "15px", + "font-size": "10px", "speed": 1.5, "loop": False, "autoplay": True, diff --git a/doc/landing-page/index.rst b/doc/landing-page/index.rst index b2a085874..64d818385 100644 --- a/doc/landing-page/index.rst +++ b/doc/landing-page/index.rst @@ -1,23 +1,120 @@ .. Dfetch documentation master file +:sd_hide_title: + .. image:: ../images/dfetch_header.png - :height: 203 - :width: 571 + :width: 100% :align: center + +Dfetch +###### + +.. grid:: 4 + + .. grid-item:: + + .. button-link:: https://pypi.org/project/dfetch/ + :color: primary + :shadow: + :expand: + + :material-regular:`download;2em` Download + + .. grid-item:: + + .. button-link:: https://dfetch.rtfd.io/ + :color: secondary + :shadow: + :expand: + + :material-regular:`description;2em` Docs + + .. grid-item:: + + .. button-link:: https://github.com/dfetch-org/dfetch/ + :color: secondary + :shadow: + :expand: + + :material-regular:`article;2em` Source + .. asciinema:: ../asciicasts/basic.cast +Are you tired of managing dependencies using Git submodules or SVN externals? Introducing *Dfetch*, a VCS agnostic, no-hassle, source-only solution +that allows you to easily retrieve dependencies as plain text from various sources. *Dfetch* eliminates the need for Git submodules or SVN externals +by providing a efficient and user-friendly way to manage your project's dependencies using *vendoring*. It promotes upstreaming changes and allows for local +customizations all while maintaining self-contained code repositories. -Dfetch -====== +Say goodbye to the hassle of traditional dependency management solutions and hello to a more efficient and streamlined process with *Dfetch*. + +.. card:: + :class-card: sd-bg-dark sd-text-light + + + .. grid:: 1 1 2 2 + + .. grid-item:: + :columns: 4 + + :material-regular:`done_all;4em;sd-text-primary` **Check for updates** + + *Dfetch* simplifies dependency management by allowing users to easily check for updates and integrate them seamlessly into their codebase. + + .. grid-item:: + :columns: 8 + + .. asciinema:: ../asciicasts/check.cast + + +.. grid:: 1 1 2 2 + + .. grid-item:: + + :material-regular:`shuffle;4em;sd-text-primary` **VCS-agnostic** + + *Dfetch* is a versatile solution, being VCS agnostic it can be used with both Git and SVN, enabling users to seamlessly manage dependencies regardless of their VCS of choice and even to mix them. + + + .. grid-item:: + + :material-regular:`archive;4em;sd-text-primary` **Self-contained** + + *Dfetch* ensures self-contained repositories by including dependencies directly within the project, eliminating external links and making deployment easier. + + + .. grid-item:: + + :material-regular:`build;4em;sd-text-primary` **Simple yaml config** + + *Dfetch* simplifies configuration with its easy-to-use YAML file, allowing users to set up and manage dependencies with minimal setup and effort. + + + .. grid-item:: + + :material-regular:`lock_open;4em;sd-text-primary` **No lock-in** + + *Dfetch* provides freedom of choice, users are not locked into using *Dfetch*, they can easily switch to other dependency management solutions. + + +.. card:: + :class-card: sd-bg-dark sd-text-light + + .. grid:: 1 1 2 2 + + .. grid-item:: + :columns: 8 + + .. asciinema:: ../asciicasts/check-ci.cast + + .. grid-item:: + :columns: 4 + + :material-regular:`smart_toy;4em;sd-text-primary` **Integrate** -What is Dfetch? ---------------- + *Dfetch* streamlines the integration process by being easily adaptable to various CI/CD automated tools, making it a breeze to implement in any development workflow. -**Dfetch is source-only no-hassle project-dependency aggregator.** +.. card:: Example config -We needed a dependency manager that was flexible enough to retrieve dependencies as plain text -from various sources. `svn externals`, `git submodules` and `git subtrees` solve a similar -problem, but not in a vcs agnostic way or completely user friendly way. -We want self-contained code repositories without any hassle for end-users. -Dfetch must promote upstreaming changes, but allow for local customizations. + .. literalinclude:: ../../dfetch.yaml + :language: yaml diff --git a/pyproject.toml b/pyproject.toml index e7d20e4aa..9a5fd8704 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -70,6 +70,7 @@ docs =[ 'sphinx-argparse==0.4.0', 'plantweb==1.2.1', 'sphinxcontrib.asciinema==0.3.7', + 'sphinx_design==0.3.0' ] test = [ 'pytest==7.2.2', From 27b4df7c6bff88e2918aac0db99d79a0c22bf83b Mon Sep 17 00:00:00 2001 From: ben Date: Tue, 10 Jan 2023 22:57:15 +0100 Subject: [PATCH 03/18] Fix auto issues --- .gitignore | 2 +- doc/landing-page/conf.py | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index ec2243c97..fbd3082b7 100644 --- a/.gitignore +++ b/.gitignore @@ -8,4 +8,4 @@ dist coverage.xml example/Tests/ build -doc/landing-page/_build \ No newline at end of file +doc/landing-page/_build diff --git a/doc/landing-page/conf.py b/doc/landing-page/conf.py index 5f38e76a9..a39d638c9 100644 --- a/doc/landing-page/conf.py +++ b/doc/landing-page/conf.py @@ -39,7 +39,7 @@ "sphinx.ext.autosectionlabel", "plantweb.directive", "sphinxcontrib.asciinema", - "sphinx_design" + "sphinx_design", ] # Add any paths that contain templates here, relative to this directory. @@ -110,7 +110,7 @@ "github_banner": True, "show_related": True, "note_bg": "#FFF59C", - 'nosidebar': True, + "nosidebar": True, } # Add any paths that contain custom static files (such as style sheets) here, From b6eecd6a16b784bb5e19f60de53a17bab3b1586f Mon Sep 17 00:00:00 2001 From: Ben Date: Tue, 10 Jan 2023 23:12:30 +0100 Subject: [PATCH 04/18] Create landing-page.yml --- .github/workflows/landing-page.yml | 35 ++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 .github/workflows/landing-page.yml diff --git a/.github/workflows/landing-page.yml b/.github/workflows/landing-page.yml new file mode 100644 index 000000000..49fcc3e3a --- /dev/null +++ b/.github/workflows/landing-page.yml @@ -0,0 +1,35 @@ +name: Landing-page + +on: + push: + branches: + - main + - feature/simplify-landing-page + +jobs: + publish: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + + - name: Setup Python + uses: actions/setup-python@v4 + with: + python-version: '3.10' + + - name: Install dependencies + run: | + pip install .[docs] + + - name: Build landing-page + run: | + cd docs/landing-page + make html + - uses: seanmiddleditch/gha-publish-to-git@master + with: + repository: https://github.com/dfetch-org/dfetch-org.github.io.git + branch: main + github_token: '${{ secrets.GITHUB_TOKEN }}' + # github_pat: '${{ secrets.GH_PAT }}' + source_folder: static/html + if: success() && github.event == 'push' From d553a4135d09e525d68104b218aacb3f14ba69bc Mon Sep 17 00:00:00 2001 From: Ben Date: Tue, 10 Jan 2023 23:20:41 +0100 Subject: [PATCH 05/18] Drop sphinx req for now --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 9a5fd8704..5a9307ca6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -66,7 +66,7 @@ development = [ 'pre-commit==3.2.0', ] docs =[ - 'sphinx==6.1.3', + 'sphinx', 'sphinx-argparse==0.4.0', 'plantweb==1.2.1', 'sphinxcontrib.asciinema==0.3.7', From e85ef63b16038a816719b92b927aa49a800c2a18 Mon Sep 17 00:00:00 2001 From: Ben Date: Tue, 10 Jan 2023 23:22:25 +0100 Subject: [PATCH 06/18] Fix paths in landing-page.yml --- .github/workflows/landing-page.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/landing-page.yml b/.github/workflows/landing-page.yml index 49fcc3e3a..68549de40 100644 --- a/.github/workflows/landing-page.yml +++ b/.github/workflows/landing-page.yml @@ -23,7 +23,7 @@ jobs: - name: Build landing-page run: | - cd docs/landing-page + cd doc/landing-page make html - uses: seanmiddleditch/gha-publish-to-git@master with: @@ -31,5 +31,5 @@ jobs: branch: main github_token: '${{ secrets.GITHUB_TOKEN }}' # github_pat: '${{ secrets.GH_PAT }}' - source_folder: static/html + source_folder: doc/landing-page/_build/html if: success() && github.event == 'push' From fa1974dd23ebaf317b4631deeaa7ad756687e730 Mon Sep 17 00:00:00 2001 From: Ben Date: Tue, 10 Jan 2023 23:27:48 +0100 Subject: [PATCH 07/18] Use correct settings for publishing --- .github/workflows/landing-page.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/landing-page.yml b/.github/workflows/landing-page.yml index 68549de40..d4ddcb184 100644 --- a/.github/workflows/landing-page.yml +++ b/.github/workflows/landing-page.yml @@ -27,9 +27,9 @@ jobs: make html - uses: seanmiddleditch/gha-publish-to-git@master with: - repository: https://github.com/dfetch-org/dfetch-org.github.io.git + repository: dfetch-org/dfetch-org.github.io branch: main - github_token: '${{ secrets.GITHUB_TOKEN }}' + github_token: '${{ secrets.GH_TOKEN }}' # github_pat: '${{ secrets.GH_PAT }}' source_folder: doc/landing-page/_build/html if: success() && github.event == 'push' From 1b2a0771078984c514f77a6d7a5bc5a6fc7ae1b6 Mon Sep 17 00:00:00 2001 From: Ben Date: Tue, 10 Jan 2023 23:31:09 +0100 Subject: [PATCH 08/18] Remove condition from step --- .github/workflows/landing-page.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/landing-page.yml b/.github/workflows/landing-page.yml index d4ddcb184..8f2499739 100644 --- a/.github/workflows/landing-page.yml +++ b/.github/workflows/landing-page.yml @@ -32,4 +32,3 @@ jobs: github_token: '${{ secrets.GH_TOKEN }}' # github_pat: '${{ secrets.GH_PAT }}' source_folder: doc/landing-page/_build/html - if: success() && github.event == 'push' From cf2210a51cc25cde8ea8e6b1e92a812bd82bc283 Mon Sep 17 00:00:00 2001 From: Ben Date: Tue, 10 Jan 2023 23:34:16 +0100 Subject: [PATCH 09/18] Use GITHUB_TOKEN instead of GH_TOKEN --- .github/workflows/landing-page.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/landing-page.yml b/.github/workflows/landing-page.yml index 8f2499739..84b1064ae 100644 --- a/.github/workflows/landing-page.yml +++ b/.github/workflows/landing-page.yml @@ -29,6 +29,6 @@ jobs: with: repository: dfetch-org/dfetch-org.github.io branch: main - github_token: '${{ secrets.GH_TOKEN }}' + github_token: '${{ secrets.GITHUB_TOKEN }}' # github_pat: '${{ secrets.GH_PAT }}' source_folder: doc/landing-page/_build/html From 135f414d1cdc1c0219c0ef1758be254dbd072c29 Mon Sep 17 00:00:00 2001 From: Ben Date: Tue, 10 Jan 2023 23:42:41 +0100 Subject: [PATCH 10/18] Already running in doc/landing-page --- .github/workflows/landing-page.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/landing-page.yml b/.github/workflows/landing-page.yml index 84b1064ae..0d40ca452 100644 --- a/.github/workflows/landing-page.yml +++ b/.github/workflows/landing-page.yml @@ -31,4 +31,4 @@ jobs: branch: main github_token: '${{ secrets.GITHUB_TOKEN }}' # github_pat: '${{ secrets.GH_PAT }}' - source_folder: doc/landing-page/_build/html + source_folder: _build/html From 7dc75862fdc71cdc9b82b93c4f108b03fb0665c2 Mon Sep 17 00:00:00 2001 From: Ben Date: Tue, 10 Jan 2023 23:45:14 +0100 Subject: [PATCH 11/18] Revert path change --- .github/workflows/landing-page.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/landing-page.yml b/.github/workflows/landing-page.yml index 0d40ca452..84b1064ae 100644 --- a/.github/workflows/landing-page.yml +++ b/.github/workflows/landing-page.yml @@ -31,4 +31,4 @@ jobs: branch: main github_token: '${{ secrets.GITHUB_TOKEN }}' # github_pat: '${{ secrets.GH_PAT }}' - source_folder: _build/html + source_folder: doc/landing-page/_build/html From 20220e71c9097286433b7dd36a736c490ccde9d8 Mon Sep 17 00:00:00 2001 From: ben Date: Wed, 11 Jan 2023 20:49:23 +0100 Subject: [PATCH 12/18] add .nojekyll file for disabling jekyll --- doc/landing-page/Makefile | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/landing-page/Makefile b/doc/landing-page/Makefile index 05cb6a637..fe606aa63 100644 --- a/doc/landing-page/Makefile +++ b/doc/landing-page/Makefile @@ -18,3 +18,4 @@ help: # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + touch "$(BUILDDIR)/html/.nojekyll" From 20542b02357bb32fe5762e0fdd5f1219d712ead0 Mon Sep 17 00:00:00 2001 From: Ben Date: Wed, 11 Jan 2023 21:05:37 +0100 Subject: [PATCH 13/18] Use other github action --- .github/workflows/landing-page.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/landing-page.yml b/.github/workflows/landing-page.yml index 84b1064ae..06de92e68 100644 --- a/.github/workflows/landing-page.yml +++ b/.github/workflows/landing-page.yml @@ -25,10 +25,10 @@ jobs: run: | cd doc/landing-page make html - - uses: seanmiddleditch/gha-publish-to-git@master + - name: Publish + uses: tsunematsu21/actions-publish-gh-pages@v1.0.2 with: - repository: dfetch-org/dfetch-org.github.io + dir: doc/landing-page/_build/html + repo: dfetch-org/dfetch-org.github.io branch: main - github_token: '${{ secrets.GITHUB_TOKEN }}' - # github_pat: '${{ secrets.GH_PAT }}' - source_folder: doc/landing-page/_build/html + token: ${{ secrets.GITHUB_TOKEN }} From a340233dbbfd4b52dd8a9dd68801e49640bed406 Mon Sep 17 00:00:00 2001 From: Ben Date: Wed, 11 Jan 2023 21:18:38 +0100 Subject: [PATCH 14/18] Use different deploy key --- .github/workflows/landing-page.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/landing-page.yml b/.github/workflows/landing-page.yml index 06de92e68..4371675e5 100644 --- a/.github/workflows/landing-page.yml +++ b/.github/workflows/landing-page.yml @@ -31,4 +31,4 @@ jobs: dir: doc/landing-page/_build/html repo: dfetch-org/dfetch-org.github.io branch: main - token: ${{ secrets.GITHUB_TOKEN }} + token: ${{ secrets.GH_DFETCH_ORG_DEPLOY }} From b39e6507051a8a1d2d2c1a2d9a61999ff472e0a8 Mon Sep 17 00:00:00 2001 From: ben Date: Wed, 11 Jan 2023 22:08:04 +0100 Subject: [PATCH 15/18] Simplify --- doc/landing-page/index.rst | 34 ++++++++-------------------------- 1 file changed, 8 insertions(+), 26 deletions(-) diff --git a/doc/landing-page/index.rst b/doc/landing-page/index.rst index 64d818385..933022f1a 100644 --- a/doc/landing-page/index.rst +++ b/doc/landing-page/index.rst @@ -10,7 +10,7 @@ Dfetch ###### -.. grid:: 4 +.. grid:: 3 .. grid-item:: @@ -48,23 +48,13 @@ customizations all while maintaining self-contained code repositories. Say goodbye to the hassle of traditional dependency management solutions and hello to a more efficient and streamlined process with *Dfetch*. -.. card:: +.. card:: :material-regular:`done_all;4em;sd-text-primary` **Check for updates** :class-card: sd-bg-dark sd-text-light + *Dfetch* simplifies dependency management by allowing users to easily check for + updates and integrate them seamlessly into their codebase. - .. grid:: 1 1 2 2 - - .. grid-item:: - :columns: 4 - - :material-regular:`done_all;4em;sd-text-primary` **Check for updates** - - *Dfetch* simplifies dependency management by allowing users to easily check for updates and integrate them seamlessly into their codebase. - - .. grid-item:: - :columns: 8 - - .. asciinema:: ../asciicasts/check.cast + .. asciinema:: ../asciicasts/check.cast .. grid:: 1 1 2 2 @@ -97,22 +87,14 @@ Say goodbye to the hassle of traditional dependency management solutions and hel *Dfetch* provides freedom of choice, users are not locked into using *Dfetch*, they can easily switch to other dependency management solutions. -.. card:: +.. card:: :material-regular:`smart_toy;4em;sd-text-primary` **Integrate** :class-card: sd-bg-dark sd-text-light - .. grid:: 1 1 2 2 - - .. grid-item:: - :columns: 8 + *Dfetch* streamlines the integration process by being easily adaptable to various CI/CD automated tools, making it a breeze to implement in any development workflow. + It can generate reports for Github, Gitlab, Jenkins, DependencyTrack and more! .. asciinema:: ../asciicasts/check-ci.cast - .. grid-item:: - :columns: 4 - - :material-regular:`smart_toy;4em;sd-text-primary` **Integrate** - - *Dfetch* streamlines the integration process by being easily adaptable to various CI/CD automated tools, making it a breeze to implement in any development workflow. .. card:: Example config From f9d94c41210bcfcefabacc620a9bcc800738cfc8 Mon Sep 17 00:00:00 2001 From: ben Date: Wed, 11 Jan 2023 22:22:45 +0100 Subject: [PATCH 16/18] Re-pin sphinx --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 5a9307ca6..9a5fd8704 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -66,7 +66,7 @@ development = [ 'pre-commit==3.2.0', ] docs =[ - 'sphinx', + 'sphinx==6.1.3', 'sphinx-argparse==0.4.0', 'plantweb==1.2.1', 'sphinxcontrib.asciinema==0.3.7', From ffe95fdf1ffc39dcf00d68be033d59ace46af9b9 Mon Sep 17 00:00:00 2001 From: ben Date: Wed, 11 Jan 2023 22:58:14 +0100 Subject: [PATCH 17/18] Ignore landing-page in regular docs --- doc/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/conf.py b/doc/conf.py index c2ff74ded..2d6905a5c 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -77,7 +77,7 @@ # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "venv"] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "venv", "landing-page"] # The name of the Pygments (syntax highlighting) style to use. pygments_style = "sphinx" From 7fb8f1903ca83766b520e8ba593d05678bd6e1c4 Mon Sep 17 00:00:00 2001 From: Ben Date: Thu, 30 Mar 2023 18:54:49 +0000 Subject: [PATCH 18/18] As workaround install sphinx-design separate --- .github/workflows/landing-page.yml | 3 ++- pyproject.toml | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/landing-page.yml b/.github/workflows/landing-page.yml index 4371675e5..be8916847 100644 --- a/.github/workflows/landing-page.yml +++ b/.github/workflows/landing-page.yml @@ -15,11 +15,12 @@ jobs: - name: Setup Python uses: actions/setup-python@v4 with: - python-version: '3.10' + python-version: "3.10" - name: Install dependencies run: | pip install .[docs] + pip install sphinx_design - name: Build landing-page run: | diff --git a/pyproject.toml b/pyproject.toml index 9a5fd8704..2c405a5ad 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -70,7 +70,7 @@ docs =[ 'sphinx-argparse==0.4.0', 'plantweb==1.2.1', 'sphinxcontrib.asciinema==0.3.7', - 'sphinx_design==0.3.0' + # 'sphinx_design==0.3.0' # Required for landing page, but requires sphinx <6 ] test = [ 'pytest==7.2.2',