Skip to content

DOC - add markdown version of the docs #2191

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
rcap107 merged 8 commits into from
Jul 2, 2026
Merged

DOC - add markdown version of the docs #2191

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d0fc07f
DOC - adding documentation in markdown format
rcap107 Jun 25, 2026
4a4df00
_
rcap107 Jun 25, 2026
b2ce737
_
rcap107 Jun 25, 2026
f3368d1
Merge remote-tracking branch 'upstream/HEAD' into doc-add-markdown-do…
rcap107 Jul 2, 2026
ef33981
lockfile
rcap107 Jul 2, 2026
c203bb4
Merge remote-tracking branch 'upstream/HEAD' into doc-add-markdown-do…
rcap107 Jul 2, 2026
0561c20
lock
rcap107 Jul 2, 2026
63c3637
adding a lighter command
rcap107 Jul 2, 2026
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
30 changes: 26 additions & 4 deletions doc/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,25 +28,47 @@ html:
# the embedding of images more robust
rm -rf $(BUILDDIR)/html/_images
#rm -rf _build/doctrees/
SKB_TABLE_REPORT_VERBOSITY=0 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
SKB_TABLE_REPORT_VERBOSITY=0 $(SPHINXBUILD) -D markdown_uri_doc_suffix="html.md" -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
# Build markdown sources so llms.txt links point to .md files
SKB_TABLE_REPORT_VERBOSITY=0 $(SPHINXBUILD) -D markdown_uri_doc_suffix="html.md" -b markdown $(ALLSPHINXOPTS) $(BUILDDIR)/markdown
cp -r $(BUILDDIR)/markdown/. $(BUILDDIR)/html/_sources/
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

html-noplot:
SKB_TABLE_REPORT_VERBOSITY=0 $(SPHINXBUILD) -D plot_gallery=0 -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
SKB_TABLE_REPORT_VERBOSITY=0 SKIP_JUPYTERLITE=1 $(SPHINXBUILD) -D markdown_uri_doc_suffix="html.md" -D plot_gallery=0 -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
# Build markdown sources so llms.txt links point to .md files
SKB_TABLE_REPORT_VERBOSITY=0 SKIP_JUPYTERLITE=1 $(SPHINXBUILD) -D markdown_uri_doc_suffix="html.md" -D plot_gallery=0 -b markdown $(ALLSPHINXOPTS) $(BUILDDIR)/markdown

@jeromedockes jeromedockes Jul 2, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does this double the time it takes to make html-noplot? (asking for a friend who finds it too slow already) if yes, maybe we can have a html-noplot-nomarkdown or similar

@rcap107 rcap107 Jul 2, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes it does, I'll add a command to only build the docs

@jeromedockes jeromedockes Jul 2, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cool thanks!

cp -r $(BUILDDIR)/markdown/. $(BUILDDIR)/html/_sources/
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

html-quick:
# Only build the HTML pages, skipping the markdown build and copying of sources
SKB_TABLE_REPORT_VERBOSITY=0 SKIP_JUPYTERLITE=1 $(SPHINXBUILD) -D plot_gallery=0 -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
SKB_TABLE_REPORT_VERBOSITY=0 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Linkcheck finished. Results are in $(BUILDDIR)/linkcheck."

linkcheck-noplot:
$(SPHINXBUILD) -D plot_gallery=0 -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck-noplot
SKB_TABLE_REPORT_VERBOSITY=0 SKIP_JUPYTERLITE=1 $(SPHINXBUILD) -D plot_gallery=0 -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck-noplot
@echo
@echo "Linkcheck (no plot) finished. Results are in $(BUILDDIR)/linkcheck-noplot."

markdown:
SKB_TABLE_REPORT_VERBOSITY=0 $(SPHINXBUILD) -b markdown $(ALLSPHINXOPTS) $(BUILDDIR)/markdown
@echo
@echo "Markdown build finished. The markdown files are in $(BUILDDIR)/markdown."

markdown-noplot:
SKB_TABLE_REPORT_VERBOSITY=0 SKIP_JUPYTERLITE=1 $(SPHINXBUILD) -D plot_gallery=0 -b markdown $(ALLSPHINXOPTS) $(BUILDDIR)/markdown
@echo
@echo "Markdown build (no plot) finished. The markdown files are in $(BUILDDIR)/markdown."

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
Expand Down
56 changes: 36 additions & 20 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,21 @@

import jinja2

# -- Copy files for docs --------------------------------------------------
#
# We avoid duplicating the information, but we do not use symlinks to be
# able to build the docs on Windows
shutil.copyfile("../RELEASE_PROCESS.rst", "RELEASE_PROCESS.rst")
shutil.copyfile("../CHANGES.rst", "CHANGES.rst")
shutil.copyfile("../CONTRIBUTING.rst", "CONTRIBUTING.rst")

# Allow skipping jupyterlite to speed up builds (e.g. html-noplot)
_SKIP_JUPYTERLITE = os.environ.get("SKIP_JUPYTERLITE", "").strip() in (
"1",
"true",
"yes",
)

# Generate the table report html file for the homepage
sys.path.append(os.path.relpath("."))
from data_ops_report import create_data_ops_report
Expand All @@ -43,14 +58,6 @@
from github_link import make_linkcode_resolve
from sphinx_gallery.notebook import add_code_cell, add_markdown_cell

# -- Copy files for docs --------------------------------------------------
#
# We avoid duplicating the information, but we do not use symlinks to be
# able to build the docs on Windows
shutil.copyfile("../RELEASE_PROCESS.rst", "RELEASE_PROCESS.rst")
shutil.copyfile("../CHANGES.rst", "CHANGES.rst")
shutil.copyfile("../CONTRIBUTING.rst", "CONTRIBUTING.rst")

# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
Expand All @@ -76,27 +83,36 @@
"sphinx_copybutton",
"sphinx_gallery.gen_gallery",
"autoshortsummary",
"sphinx_llms_txt",
"sphinx_markdown_builder",
]

# -- sphinx-llms-txt configuration -------------------------------------------
# Link to Markdown sources in _sources/ (generated by the markdown builder).
llms_txt_uri_template = "{base_url}_sources/{docname}.md"

try:
import sphinxext.opengraph # noqa

extensions.append("sphinxext.opengraph")
except ImportError:
print("ERROR: sphinxext.opengraph import failed")

try:
import jupyterlite_sphinx # noqa: F401

extensions.append("jupyterlite_sphinx")
with_jupyterlite = True
except ImportError:
# In some cases we don't want to require jupyterlite_sphinx to be installed,
# e.g. the doc-min-dependencies build
warnings.warn(
"jupyterlite_sphinx is not installed, you need to install it "
"if you want JupyterLite links to appear in each example"
)
if not _SKIP_JUPYTERLITE:
try:
import jupyterlite_sphinx # noqa: F401

extensions.append("jupyterlite_sphinx")
with_jupyterlite = True
except ImportError:
# In some cases we don't want to require jupyterlite_sphinx to be installed,
# e.g. the doc-min-dependencies build
warnings.warn(
"jupyterlite_sphinx is not installed, you need to install it "
"if you want JupyterLite links to appear in each example"
)
with_jupyterlite = False
else:
with_jupyterlite = False

import sphinx_autosummary_accessors
Expand Down
62 changes: 52 additions & 10 deletions pixi.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 8 additions & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@ dev = [
"sphinx-copybutton",
"sphinx-gallery",
"sphinxext-opengraph",
"sphinx-llms-txt",
"sphinx-markdown-builder",
"sphinx-autosummary-accessors",
"statsmodels",

Expand Down Expand Up @@ -124,6 +126,8 @@ sphinx-gallery = "*"
sphinxext-opengraph = "*"
sphinx-autosummary-accessors = ">=2025.3.1,<2026"
sphinx-sitemap = "*"
sphinx-llms-txt = "*"
sphinx-markdown-builder = "*"
statsmodels = "*"
optuna = "*"
skorch = "*"
Expand Down Expand Up @@ -221,7 +225,8 @@ python = "~=3.14.0"

[tool.pixi.feature.doc.tasks]
build-doc = { cmd = "make html", cwd = "doc" }
build-doc-quick = { cmd = "make html-noplot", cwd = "doc" }
build-doc-no-plot = { cmd = "make html-no-plot", cwd = "doc" }
build-doc-quick = { cmd = "make html-quick", cwd = "doc" }
clean-doc = { cmd = "make clean", cwd = "doc" }
linkcheck = { cmd = "make linkcheck", cwd = "doc" }
linkcheck-quick = { cmd = "make linkcheck-noplot", cwd = "doc" }
Expand Down Expand Up @@ -278,6 +283,7 @@ exclude = [
"dist",
"doc/_build",
"doc/auto_examples",
"skrub/_docs/*.py",
"build",
"pixi.lock",
]
Expand Down Expand Up @@ -364,6 +370,7 @@ xfail_strict = true
addopts = ["--doctest-modules", "--strict-config", "--strict-markers"]
doctest_optionflags = "NORMALIZE_WHITESPACE ELLIPSIS"


[tool.codespell]
# Ref: https://github.com/codespell-project/codespell#using-a-config-file
skip = '.git*,*.svg,package-lock.json,*.lock,*.css,*-min.*,pyproject.toml'
Expand Down
Loading