Support Sphinx 7 #130
Labels
enhancement
New feature or request
Comments
|
This blocks us from upgrading to Sphinx 7 |
|
This is also blocking us from updating to Sphinx 7 on multiple repos. Could we get #131 approved and merged, together with a new release? =) |
2 tasks
nodiscc
added a commit
to nodiscc/hecat
that referenced
this issue
Jul 6, 2023
- sphinx-design is not compatible with sphinx 7 executablebooks/sphinx-design#130
1 task
nodiscc
added a commit
to nodiscc/hecat
that referenced
this issue
Jul 8, 2023
- sphinx-design is not compatible with sphinx 7 executablebooks/sphinx-design#130
nodiscc
added a commit
to nodiscc/hecat
that referenced
this issue
Jul 11, 2023
- sphinx-design is not compatible with sphinx 7 executablebooks/sphinx-design#130
nodiscc
added a commit
to nodiscc/hecat
that referenced
this issue
Jul 13, 2023
- export multi-page markdown site from YAML software data - the output can be used as intermediary source for sphinx-build to generate a static HTML site - fixes #15 - display extra information for each software in the markdown output (stars count, license, last update date, languages/platforms, licenses) - show a ? when the stars number or last update date is unavailable - render last update date in orange/red when last update is older than 6/12 months - allow excluding items with specific licenses from rendering (exclude items with proprietary licenses) - write output files to the md/ subdirectory under the configured output_directory - build sub-pages for each tag, under md/tags/, including metadat for each tag (description, external links, redirects, related tags - don't render software header on pages where there are no software entries - let tags in the software list link to the relevant tag subpage - add sphinx, myst-parser, sphinx furo theme as dependencies, pin dependencies versions - pin sphinx to version <7, sphinx-design is not compatible with sphinx 7 executablebooks/sphinx-design#130 - use hidden toctree to generate the left sidebar (include all tags subpages in the sidebar), limit TOC depth to 2 - use sphinx-design built-in octicons when possible - add custom CSS inline in markdown documents - add integration tests for exporters/markdown_multipage and sphinx-build generation, add sample sphinx configuration file with relevant options - sphinx: store sphinx doctrees outside of the html document root - sphinx: use favicon/static resources provided by the source directory in _static/ and include them in the HTML output tree - ref. https://github.com/readthedocs/sphinx_rtd_theme/blob/master/docs/index.rst - ref. https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html - ref. https://www.sphinx-doc.org/en/master/usage/quickstart.html - ref. https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-toctree - ref. https://myst-parser.readthedocs.io/en/latest/syntax/organising_content.html - ref. https://github.com/executablebooks/MyST-Parser - ref. https://pradyunsg.me/furo/customisation/ - ref. https://sphinx-design.readthedocs.io/en/furo-theme/badges_buttons.html#inline-icons - ref. https://sphinx-design.readthedocs.io/en/furo-theme/index.html - update documentation
nodiscc
added a commit
to awesome-selfhosted/awesome-selfhosted-data
that referenced
this issue
Jul 24, 2023
- build markdown/HTML versions, use separate makefile targets/hecat configuration files for each export format/push task - add non-free.md generation step to markdown export hecat configuration file - add makefile targets to push exports to https://github.com/awesome-selfhosted/awesome-selfhosted and https://github.com/nodiscc/awesome-selfhosted-html-preview - install: install sphinx <7 directly using pip since it can't be installed from setup.py sphinx-doc/sphinx#11130 - pin sphinx to version <7, sphinx-design is not compatible with sphinx 7 executablebooks/sphinx-design#130 - add sphinx configuration file
nodiscc
added a commit
to awesome-selfhosted/awesome-selfhosted-data
that referenced
this issue
Jul 24, 2023
- build markdown/HTML versions, use separate makefile targets/hecat configuration files for each export format/push task - add non-free.md generation step to markdown export hecat configuration file - add makefile targets to push exports to https://github.com/awesome-selfhosted/awesome-selfhosted and https://github.com/nodiscc/awesome-selfhosted-html-preview - install: install sphinx <7 directly using pip since it can't be installed from setup.py sphinx-doc/sphinx#11130 - pin sphinx to version <7, sphinx-design is not compatible with sphinx 7 executablebooks/sphinx-design#130 - add sphinx configuration file - tools/makefile: monkeypatch furo theme to display build tools and license link in footer (furo/sphinx does not provide a way to customize this pradyunsg/furo#612) - fix dependencies between makefile targets - setup/document SSH deploy keys usage - each repository requires a different deploy key, trying to add a deploy key to repo B, which has already been added to repo A results in error 'this key already exists' - set git remote URL to use ssh URIs before push (required to use SSH deploy keys) - when referencing an environment secret, environment: key must be defined explicitly for the step (https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#referencing-an-environment) - use a single SSH key file/no ssh-agent, else git push will try to use the first registered key and fail with permission denied when trying to push to the HTML repository - use variables to identify target repos - use temporary repositories as push destination
|
Likely resolved by #148! A |
|
all done 👍 |
nodiscc
added a commit
to nodiscc/hecat
that referenced
this issue
Jul 27, 2023
- executablebooks/sphinx-design#130 - sphinx must be installed manually/ install through install_requires still blocked by sphinx-doc/sphinx#11130
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Context
No context required
Proposal
No response
Tasks and updates
No response
The text was updated successfully, but these errors were encountered: