Skip to content

Add: dependency page to guide #106

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.

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
merged 32 commits into from
Dec 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
b6d9fb9
Add dependency section to guide
lwasser Oct 11, 2023
480ce28
Fix: a few fixes from Jeremiah
lwasser Oct 12, 2023
2cb6682
Fix: feedback from review
lwasser Oct 12, 2023
46230f7
Fix: more edits from the review
lwasser Dec 6, 2023
7e92943
Fix: numerous edits from the review
lwasser Dec 7, 2023
302a204
More edits & restructure from @sneakers-the-rat
lwasser Dec 7, 2023
5430b82
Fix: Broken link
lwasser Dec 7, 2023
4edbb75
Fix: add an intro - what is a dependency- to the page
lwasser Dec 7, 2023
026f983
Fix: add intro what are dependencies?
lwasser Dec 7, 2023
b6449a5
Fix: more typos and fixes from the review
lwasser Dec 7, 2023
faa012f
Fix: add image to explain optional vs required
lwasser Dec 7, 2023
4796527
Fix: text cleanup
lwasser Dec 8, 2023
4a4a78e
Fix: text cleanup & a few more tools
lwasser Dec 8, 2023
b3bd8ae
Fix: text cleanup
lwasser Dec 8, 2023
4e364ea
Fix: text cleanup
lwasser Dec 8, 2023
17294a4
Fix: text cleanup
lwasser Dec 8, 2023
a61b9bd
Fix: text cleanup
lwasser Dec 8, 2023
260c226
Fix: text cleanup
lwasser Dec 8, 2023
5df5e0b
Fix: text cleanup
lwasser Dec 8, 2023
d8b9477
Fix: text cleanup
lwasser Dec 8, 2023
9955a8a
Fix: text cleanup
lwasser Dec 8, 2023
7e28f74
Fix: text cleanup
lwasser Dec 8, 2023
dca6edd
Fix: text cleanup
lwasser Dec 8, 2023
df1fadd
Fix: text cleanup
lwasser Dec 8, 2023
77ee115
Fix: text cleanup
lwasser Dec 8, 2023
969f777
Fix: text cleanup
lwasser Dec 8, 2023
cd95be8
Fix: updated dep image
lwasser Dec 8, 2023
3656543
Fix: more edits from review, new image and add todo extension to sphinx
lwasser Dec 8, 2023
400b9b1
Fix: image tweaks from jeremy's feedback
lwasser Dec 8, 2023
be06471
Fix: another typo
lwasser Dec 8, 2023
ea3afc1
Fix: package name consistency in text and graphics
lwasser Dec 15, 2023
f7e2927
Fix: feedback from Phil and Maria on graphics
lwasser Dec 15, 2023
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
1 change: 1 addition & 0 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
"sphinx_design",
"sphinx_copybutton",
"sphinx.ext.intersphinx",
"sphinx.ext.todo",
"sphinx_sitemap",
"sphinxext.opengraph",
]
Expand Down
Binary file added images/python-package-dependencies.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/python-package-dependency-types.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 14 additions & 11 deletions noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
nox.options.reuse_existing_virtualenvs = True

OUTPUT_DIR = "_build"
build_command = ["-b", "html", ".", "/".join([OUTPUT_DIR, "/html"])]
docs_dir = os.path.join("_build", "html")
build_command = ["-b", "html", ".", docs_dir]

@nox.session
def docs(session):
Expand All @@ -25,12 +26,14 @@ def docs_live(session):
"build_assets",
"tmp",
]

# Explicitly include custom CSS in each build since
# sphinx doesn't think _static files should change since,
# well, they're static.
# Include these as the final `filenames` argument

AUTOBUILD_INCLUDE = [
"_static/pyos.css"
os.path.join("_static", "pyos.css")
]

# ----------------
Expand All @@ -39,19 +42,19 @@ def docs_live(session):
for folder in AUTOBUILD_IGNORE:
cmd.extend(["--ignore", f"*/{folder}/*"])

cmd.extend(build_command)
#cmd.extend(build_command)
cmd.extend(build_command + session.posargs)

# use positional arguments if we have them
if len(session.posargs) > 0:
cmd.extend(session.posargs)
# otherwise use default output and include directory
else:
cmd.extend(AUTOBUILD_INCLUDE)
# Use positional arguments if we have them
# if len(session.posargs) > 0:
# cmd.extend(session.posargs)
# # Otherwise use default output and include directory
# else:
# cmd.extend(AUTOBUILD_INCLUDE)

# ----------------
session.run(*cmd)

docs_dir = os.path.join("_build", "html")


@nox.session(name="docs-clean")
def clean_dir(dir_path=docs_dir):
Expand Down
Loading