saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-10 06:41:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Remove epub generation for docs

Browse source
This commit is contained in:
ScriptAutomate 2024-07-30 14:49:42 -05:00 • committed by Daniel Wozniak
parent 53ddf5a32e
commit c222b6e978
8 changed files with 1 additions and 105 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.github/workflows/build-docs.yml vendored
View file

@ -32,7 +32,6 @@ jobs:
- linkcheck
- spellcheck
- html
- epub
# - pdf
steps:

6
.github/workflows/staging.yml vendored
View file

@ -2847,12 +2847,6 @@ jobs:
name: salt-${{ needs.prepare-workflow.outputs.salt-version }}-docs-html.tar.xz
path: artifacts/release
- name: Download Release Documentation (ePub)
uses: actions/download-artifact@v4
with:
name: Salt-${{ needs.prepare-workflow.outputs.salt-version }}.epub
path: artifacts/release
- name: Show Release Artifacts
run: |
tree -a artifacts/release

6
.github/workflows/templates/staging.yml.jinja vendored
View file

@ -124,12 +124,6 @@ concurrency:
name: salt-${{ needs.prepare-workflow.outputs.salt-version }}-docs-html.tar.xz
path: artifacts/release
- name: Download Release Documentation (ePub)
uses: actions/download-artifact@v4
with:
name: Salt-${{ needs.prepare-workflow.outputs.salt-version }}.epub
path: artifacts/release
- name: Show Release Artifacts
run: |
tree -a artifacts/release

8
doc/Makefile
View file

@ -16,7 +16,7 @@ ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean check_sphinx-build html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
.PHONY: help clean check_sphinx-build html dirhtml singlehtml pickle json htmlhelp qthelp devhelp latex latexpdf text man changes linkcheck doctest
help:
@echo "Please use \`make <target>' where <target> is one of"
@ -28,7 +28,6 @@ help:
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " pdf to make Salt-all.pdf and splitted pdf using xelatex"
@echo " cheatsheet to create salt-cheatsheet.pdf"
@ -101,11 +100,6 @@ devhelp: check_sphinx-build
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Salt"
@echo "# devhelp"
epub: check_sphinx-build
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex: check_sphinx-build
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo

2
doc/_themes/saltstack2/layout.html vendored
View file

@ -193,10 +193,8 @@
{% if not (build_type == repo_primary_branch or build_type == "next") and on_saltstack %}
<li><a class="icon-dl" href="/en/pdf/Salt-{{ release }}.pdf"><img height="25" width="25" class="nolightbox" src="{{ pathto('_static/images/pdf_icon.svg', 1) }}"></a></li>
<li><a class="icon-dl" href="/en/epub/Salt-{{ release }}.epub"><img height="25" width="18" class="nolightbox" src="{{ pathto('_static/images/epub_icon.svg', 1) }}"></a></li>
{% elif build_type == repo_primary_branch and on_saltstack %}
<li><a class="icon-dl" href="/en/pdf/Salt-{{ repo_primary_branch }}.pdf"><img height="25" width="25" class="nolightbox" src="{{ pathto('_static/images/pdf_icon.svg', 1) }}"></a></li>
<li><a class="icon-dl" href="/en/epub/Salt-{{ repo_primary_branch }}.epub"><img height="25" width="18" class="nolightbox" src="{{ pathto('_static/images/epub_icon.svg', 1) }}"></a></li>
{% endif %}
</ul>
</nav>

25
doc/_themes/saltstack2/static/images/epub_icon.svg vendored
View file

@ -1,25 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Generator: Adobe Illustrator 15.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg version="1.1" id="Ebene_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
width="600px" height="800px" viewBox="0 0 600 800" enable-background="new 0 0 600 800" xml:space="preserve">
<g>
<path fill="#86B918" d="M131.969,755.898c11.244,0,19.199-4.599,25.85-11.573l7.591,6.827c-8.227,9.192-18.222,15.376-33.76,15.376
c-22.534,0-40.906-17.294-40.906-42.824c0-23.777,16.649-42.815,39.333-42.815c24.237,0,38.203,19.347,38.203,43.453
c0,1.113,0,2.381-0.15,3.803h-65.031C104.838,745.921,117.536,755.898,131.969,755.898z M155.927,719.111
c-1.277-14.907-9.844-27.916-26.194-27.916c-14.242,0-25.043,11.909-26.639,27.916H155.927z"/>
<path fill="#41281B" d="M231.23,725.461h-26.957v39.177H191.75V653.616h41.562c25.043,0,41.542,13.331,41.542,35.373
C274.854,713.096,254.87,725.461,231.23,725.461z M232.333,665.196h-28.062v48.839h27.447c18.386,0,30.441-9.823,30.441-24.577
C262.163,673.444,250.28,665.196,232.333,665.196z"/>
<path fill="#41281B" d="M388.377,717.193c0,32.363-18.535,49.174-46.3,49.174c-27.424,0-46.134-16.811-46.134-48.208v-64.543
h12.518v63.752c0,23.939,12.693,37.425,33.954,37.425c20.453,0,33.462-12.378,33.462-36.634v-64.543h12.5V717.193z"/>
<path fill="#41281B" d="M500.202,681.379c0,14.584-8.885,22.034-17.602,25.85c13.163,3.95,23.771,11.561,23.771,26.958
c0,19.172-16.014,30.451-40.269,30.451h-50.112V653.616h48.048C485.92,653.616,500.202,664.392,500.202,681.379z M487.51,683.122
c0-11.112-8.739-18.24-24.573-18.24h-34.59v38.229h33.63C477.033,703.104,487.51,696.277,487.51,683.122z M493.698,733.388
c0-12.218-10.162-19.192-29.513-19.192h-35.839v39.163h38.076C483.238,753.358,493.698,745.921,493.698,733.388z"/>
</g>
<path fill="#86B918" d="M298.549,467.913L129.228,298.579L298.549,129.27l56.446,56.435L242.104,298.579l56.441,56.443
l169.323-169.308L320.366,38.217c-12.043-12.055-31.579-12.055-43.634,0L38.169,276.781c-12.044,12.043-12.044,31.58,0,43.633
l238.563,238.557c12.055,12.05,31.591,12.05,43.634,0l238.565-238.557c12.044-12.053,12.044-31.59,0-43.633l-34.631-34.622
L298.549,467.913z"/>
</svg>
Side by side

Before

Width:  |  Height:  |  Size: 2.3 KiB

13
doc/conf.py
View file

@ -383,19 +383,6 @@ man_pages = [
]
### epub options
epub_title = "Salt Documentation"
epub_author = "VMware, Inc."
epub_publisher = epub_author
epub_copyright = copyright
epub_scheme = "URL"
epub_identifier = "http://saltproject.io/"
epub_tocdup = False
# epub_tocdepth = 3
def skip_mod_init_member(app, what, name, obj, skip, options):
# pylint: disable=too-many-arguments,unused-argument
if name.startswith("_"):

45
tools/docs.py
View file

@ -133,51 +133,6 @@ def html(
)
@docs.command(
name="epub",
arguments={
"no_clean": {
"help": "Don't cleanup prior to building",
},
"no_color": {
"help": "Disable colored output.",
},
},
)
def epub(ctx: Context, no_clean: bool = False, no_color: bool = False):
if no_clean is False:
ctx.run("make", "clean", cwd="doc/", check=True)
opts = [
"-j",
"auto",
"--keep-going",
]
if no_color is False:
opts.append("--color")
ctx.run(
"make",
"epub",
f"SPHINXOPTS={' '.join(opts)}",
cwd="doc/",
check=True,
)
artifact = tools.utils.REPO_ROOT / "doc" / "_build" / "epub" / "Salt.epub"
if "LATEST_RELEASE" in os.environ:
shutil.move(
artifact, artifact.parent / f"Salt-{os.environ['LATEST_RELEASE']}.epub"
)
artifact = artifact.parent / f"Salt-{os.environ['LATEST_RELEASE']}.epub"
github_output = os.environ.get("GITHUB_OUTPUT")
if github_output is not None:
with open(github_output, "a", encoding="utf-8") as wfh:
wfh.write(
"has-artifacts=true\n"
f"artifact-name={artifact.resolve().name}\n"
f"artifact-path={artifact.resolve()}\n"
)
@docs.command(
name="pdf",
arguments={