Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Sphinx - core #1930

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pablogsal merged 10 commits into from
Jun 8, 2021
Merged

Sphinx - core #1930

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
0bb832e
Update .gitignore
AA-Turner Apr 18, 2021
4e7f7e0
Add base sphinx build script
AA-Turner Apr 18, 2021
332ffb9
Add requirements file
AA-Turner Apr 18, 2021
855cf8b
Update Makefile with sphinx targets
AA-Turner Apr 18, 2021
0f2033e
Add GH actions deploy script
AA-Turner Apr 18, 2021
d2c92d5
Add conf.py and contents.rst for Sphinx
AA-Turner Apr 18, 2021
b162d53
Add parallel deploy
AA-Turner Apr 18, 2021
23a4207
Remove non-existent Makefile target
AA-Turner May 7, 2021
dc236e0
Update deploy script
AA-Turner May 7, 2021
64605e9
Build to directories by default
AA-Turner May 7, 2021
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
Prev Previous commit
Build to directories by default
  • Loading branch information
@AA-Turner
AA-Turner committed Jun 8, 2021
commit 64605e91d7e09a1a1e4c79143010e70967cdbad8
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,4 +70,4 @@ fail_on_warning:
$(SPHINX_BUILD) --fail-on-warning

check_links:
$(SPHINX_BUILD) --builder linkcheck
$(SPHINX_BUILD) --check-links
12 changes: 9 additions & 3 deletions build.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@

def create_parser():
parser = argparse.ArgumentParser(description="Build PEP documents")
# builders:
parser.add_argument("-b", "--builder", default="html", choices=("html", "dirhtml", "linkcheck"))
# alternative builders:
parser.add_argument("-l", "--check-links", action="store_true")

# flags / options
parser.add_argument("-f", "--fail-on-warning", action="store_true")
Expand All @@ -30,6 +30,12 @@ def create_parser():
build_directory = root_directory / "build" # synchronise with deploy-gh-pages.yaml -> deploy step
doctree_directory = build_directory / ".doctrees"

# builder configuration
sphinx_builder = "dirhtml"
if args.check_links:
sphinx_builder = "linkcheck"

# other configuration
config_overrides = {}
if args.nitpicky:
config_overrides["nitpicky"] = True
Expand All @@ -39,7 +45,7 @@ def create_parser():
confdir=source_directory,
outdir=build_directory,
doctreedir=doctree_directory,
buildername=args.builder,
buildername=sphinx_builder,
confoverrides=config_overrides,
warningiserror=args.fail_on_warning,
parallel=args.jobs,
Expand Down