From 836375f54403c93510a03a5d44d094f326fe1954 Mon Sep 17 00:00:00 2001 From: Manuel Kaufmann Date: Wed, 12 Jun 2024 17:15:23 +0200 Subject: [PATCH 1/5] Remove example projects from readme I'm removing the "Example projects" list from the readme since we don't need to maintain that list in two separate places. We are already doing this in https://docs.readthedocs.io/en/stable/examples.html where we added Antora and this readme was not updated. --- README.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/README.md b/README.md index 2743067..7a3c72c 100644 --- a/README.md +++ b/README.md @@ -88,12 +88,6 @@ The list is a work in progress, please feel invited to [contribute](#contributin -## Example projects - -- [Basic Sphinx example](https://github.com/readthedocs-examples/example-sphinx-basic) - Basic example of using Sphinx on Read the Docs. **#sphinx**. -- [Basic MkDocs example](https://github.com/readthedocs-examples/example-mkdocs-basic) - Basic example of using MkDocs on Read the Docs. **#mkdocs**. -- [Jupyter Book example](https://github.com/readthedocs-examples/example-jupyter-book) - Using Jupyter Book on Read the Docs with popular extensions. **#jupyter-notebook** **#sphinx**. - ## Tag cloud The categories in this list are intersecting at the following tags: From 3fb2e85eb848c4c81da206be28e56b6e64ac2703 Mon Sep 17 00:00:00 2001 From: Manuel Kaufmann Date: Wed, 12 Jun 2024 17:29:09 +0200 Subject: [PATCH 2/5] Update README.md The link to twitter is dead. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7a3c72c..12b88da 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ The list is a work in progress, please feel invited to [contribute](#contributin - [django-cms](https://docs.django-cms.org/) - django-cms's developer documentation is as extensive as it's well-organized. It uses the Furo theme. **#sphinx** **#large-project**. - [Ray](https://docs.ray.io/) - Ray is a documentation project spanning multiple software components. It uses several extensions from the Executable Book project. Features are showcased in [this twitter thread](https://twitter.com/readthedocs/status/1663923671470047234). **#sphinx** **#themes** **#large-project**. - [Scrapy](https://docs.scrapy.org/) - Embeds a lot of reference snippets and uses `sphinx-hoverxref` for quick reference tooltips. Lots of inspiration to be found in content organization. **#sphinx**. -- [setuptools](https://setuptools.pypa.io/) - Lots of features, using the Furo theme. [Twitter thread](https://twitter.com/readthedocs/status/1546527820150718469) with some examples. **#sphinx** **#themes**. +- [setuptools](https://setuptools.pypa.io/) - Lots of features, using the Furo theme. **#sphinx** **#themes**. - [sphinx-needs](https://sphinx-needs.readthedocs.io/) - Documentation of `sphinx-needs`. **#sphinx** **#themes**. - [sphinx-immaterial](https://sphinx-immaterial.readthedocs.io/) - Documentation of `sphinx-immaterial`, a Material theme for Sphinx, based on Material for MkDocs. **#sphinx** **#themes**. - [Uberspace](https://manual.uberspace.de/) - Customized sidebar and footer, adding project's branding through custom CSS and HTML to `sphinx_rtd_theme`. Latest version and release date on front page. **#sphinx** **#themes** **#custom-theme**. From ba0a6ab78f7da2e371c5b5271aedec3b8b727751 Mon Sep 17 00:00:00 2001 From: Manuel Kaufmann Date: Wed, 12 Jun 2024 18:35:16 +0200 Subject: [PATCH 3/5] Use LTS node version --- .github/workflows/lint.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index f34cc5f..b0cdf98 100644 --- a/.github/workflows/lint.yaml +++ b/.github/workflows/lint.yaml @@ -20,6 +20,9 @@ jobs: fetch-depth: 0 - name: asdf_install uses: asdf-vm/actions/install@v1 + with: + tool_versions: | + nodejs 20.14.0 - name: "linting: ${{ matrix.files }}" run: npx -y awesome-lint ${{ matrix.files }} awesome-bot: From 9e37495e07be92cfe92e2991b832ba1086e6a998 Mon Sep 17 00:00:00 2001 From: Manuel Kaufmann Date: Wed, 12 Jun 2024 18:38:14 +0200 Subject: [PATCH 4/5] Remove toc entry --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 12b88da..eb82e2f 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,6 @@ The list is a work in progress, please feel invited to [contribute](#contributin - [MkDocs projects](#mkdocs-projects) - [API Reference](#api-reference) - [Science projects](#science-projects) -- [Example projects](#example-projects) - [Tag cloud](#tag-cloud) From 173a6cbb08e5f477ab877ba0e02c80765209c14f Mon Sep 17 00:00:00 2001 From: Manuel Kaufmann Date: Thu, 13 Jun 2024 10:24:37 +0200 Subject: [PATCH 5/5] Re-add the twitter thread --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index eb82e2f..cc5b0cf 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ The list is a work in progress, please feel invited to [contribute](#contributin - [django-cms](https://docs.django-cms.org/) - django-cms's developer documentation is as extensive as it's well-organized. It uses the Furo theme. **#sphinx** **#large-project**. - [Ray](https://docs.ray.io/) - Ray is a documentation project spanning multiple software components. It uses several extensions from the Executable Book project. Features are showcased in [this twitter thread](https://twitter.com/readthedocs/status/1663923671470047234). **#sphinx** **#themes** **#large-project**. - [Scrapy](https://docs.scrapy.org/) - Embeds a lot of reference snippets and uses `sphinx-hoverxref` for quick reference tooltips. Lots of inspiration to be found in content organization. **#sphinx**. -- [setuptools](https://setuptools.pypa.io/) - Lots of features, using the Furo theme. **#sphinx** **#themes**. +- [setuptools](https://setuptools.pypa.io/) - Lots of features, using the Furo theme. [Twitter thread](https://twitter.com/readthedocs/status/1546527820150718469) with some examples. **#sphinx** **#themes**. - [sphinx-needs](https://sphinx-needs.readthedocs.io/) - Documentation of `sphinx-needs`. **#sphinx** **#themes**. - [sphinx-immaterial](https://sphinx-immaterial.readthedocs.io/) - Documentation of `sphinx-immaterial`, a Material theme for Sphinx, based on Material for MkDocs. **#sphinx** **#themes**. - [Uberspace](https://manual.uberspace.de/) - Customized sidebar and footer, adding project's branding through custom CSS and HTML to `sphinx_rtd_theme`. Latest version and release date on front page. **#sphinx** **#themes** **#custom-theme**.