Skip to content
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

Fix building of docs with the lastest numpy and sphinx #709

Merged
merged 14 commits into from
Jul 24, 2023
Merged

Fix building of docs with the lastest numpy and sphinx #709

Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
b52d5fd
Use float instead of np.float
keszybz Jul 17, 2023
b87ba7f
setup: fix git invocation for exlinks, add override
keszybz Jul 17, 2023
8320b2a
Fix CMA tanle miss align and conf modules
fmder Jul 23, 2023
9e0095c
Merge branch 'master' into keszybz-doc-build
fmder Jul 23, 2023
c3e13a9
Remove math warnings and align mathjax left
fmder Jul 24, 2023
7b337b7
Adjust doc to MetaEphemeral
fmder Jul 24, 2023
2e4b9ce
Fix title underscore too short warning
fmder Jul 24, 2023
0f05b73
Fix EDA example references
fmder Jul 24, 2023
9b7b3c8
Fix emphasis line
fmder Jul 24, 2023
9103dc2
Fix include path
fmder Jul 24, 2023
48f2214
Fix keyword
fmder Jul 24, 2023
2a5b6ec
Fixed reference to numpy tutorial
fmder Jul 24, 2023
649e5ee
Fixed reference to GA One Max
fmder Jul 24, 2023
3a764d7
Fix ref to fitness creation part
fmder Jul 24, 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
Prev Previous commit
Next Next commit
setup: fix git invocation for exlinks, add override 
The 'tree' would be bytes, so we'd end up with an url like
https://github.com/DEAP/deap/blob/b'0123456'/examples/.

While at it, allow the user to override the detect hash. This is particularly
useful when there are local modifications, and HEAD hash doesn't yet exist on
github, and it's nicer to link to some other commit, or even 'master'.

Also, sphinx 6 enforces the second item in the extlinks tuple (the title)
to have exactly one '%s'.
  • Loading branch information
@keszybz
keszybz committed Jul 17, 2023
commit b87ba7f941a366da17edc5590b2d42d1659cb989
18 changes: 10 additions & 8 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys, time
import sys, time, os

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
Expand Down Expand Up @@ -128,13 +128,15 @@

# -- Options for extlinks extension ----------------------------------------------
import subprocess
try:
tree = subprocess.check_output(["git", "rev-parse", "HEAD"]).strip()
except OSError:
import warnings
warnings.warn("Cannot link examples because we cannot retrieve the git version", Warning)
else:
extlinks = {'example': ('https://github.com/DEAP/deap/blob/{tree}/examples/%s.py'.format(tree=tree), "examples/")}
tree = os.getenv('GITHUB_COMMIT')
if tree is None:
try:
tree = subprocess.check_output(["git", "rev-parse", "HEAD"], text=True).strip()
except OSError:
import warnings
warnings.warn("Cannot link examples because we cannot retrieve the git version", Warning)
if tree:
extlinks = {'example': ('https://github.com/DEAP/deap/blob/{tree}/examples/%s.py'.format(tree=tree), "examples/%s")}
# -- Options for HTML output ---------------------------------------------------

# Add any paths that contain custom themes here, relative to this directory.
Expand Down