Page MenuHomeSoftware Heritage
Differential D1209

apidoc: Copy source files instead of assuming they are installed in the same dir.
ClosedPublic
Actions

Authored by vlorentz on Feb 28 2019, 2:35 PM.

Details

Reviewers
anlambert
Group Reviewers
Reviewers
Commits
rDDOC43d8513324aa: apidoc: Copy source files instead of assuming they are installed in the same…
rDDOCb956d43d8244: apidoc: Copy source files instead of assuming they are installed in the same…
Summary

This is no longer true since D1198.

Diff Detail

Repository
rDDOC Development documentation
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

vlorentz created this revision.Feb 28 2019, 2:35 PM
Herald added a reviewer: Reviewers. · View Herald TranscriptFeb 28 2019, 2:35 PM
Harbormaster completed remote builds in B4484: Diff 3789.Feb 28 2019, 2:35 PM
vlorentz updated this revision to Diff 3790.Feb 28 2019, 2:36 PM
  • remove unrelated change
Harbormaster completed remote builds in B4485: Diff 3790.Feb 28 2019, 2:36 PM
vlorentz updated this revision to Diff 3800.Feb 28 2019, 4:12 PM
  • rebase
Harbormaster completed remote builds in B4494: Diff 3800.Feb 28 2019, 4:12 PM
anlambert accepted this revision.Feb 28 2019, 4:16 PM
anlambert added a subscriber: anlambert.
anlambert added inline comments.
docs/bin/ln-sphinx-subprojects
4

mkdir sources should be sufficient here as the swh directory will be created by the cp -fr command below

This revision is now accepted and ready to land.Feb 28 2019, 4:16 PM
vlorentz updated this revision to Diff 3804.Feb 28 2019, 5:09 PM
  • simplify mkdir
Harbormaster completed remote builds in B4498: Diff 3804.Feb 28 2019, 5:09 PM
vlorentz marked an inline comment as done.Feb 28 2019, 5:09 PM
Closed by commit rDDOCb956d43d8244: apidoc: Copy source files instead of assuming they are installed in the same… (authored by vlorentz). · Explain WhyFeb 28 2019, 5:15 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathSize
docs/
1 line
6 lines
bin/
5 lines

Diff 3805

View Options

docs/.gitignore

Loading...
View Options

docs/Makefile

SPHINXOPTS ?= SPHINXOPTS ?=
SPHINXBUILD = python3 -c 'import sphinx, sys; sys.exit(sphinx.main(sys.argv))' SPHINXBUILD = python3 -c 'import sphinx, sys; sys.exit(sphinx.main(sys.argv))'
SOURCEDIR = . SOURCEDIR = .
BUILDDIR = _build BUILDDIR = _build
HTMLDIR = $(BUILDDIR)/html HTMLDIR = $(BUILDDIR)/html
SWHPKGDIR = `python3 -c 'import swh; print(swh.__path__[0])'` SWHPKGDIR = sources/swh/
INSTALL_HOST = pergamon.internal.softwareheritage.org INSTALL_HOST = pergamon.internal.softwareheritage.org
INSTALL_DIR = /srv/softwareheritage/docs/webroot/devel INSTALL_DIR = /srv/softwareheritage/docs/webroot/devel
INSTALL_GROUP = swhdev INSTALL_GROUP = swhdev
INSTALL_PERMS = g+rwX INSTALL_PERMS = g+rwX
SPHINXAPIDOC = sphinx-apidoc SPHINXAPIDOC = sphinx-apidoc
APIDOC_DIR = apidoc APIDOC_DIR = apidoc
APIDOC_OPTS = --ext-viewcode APIDOC_OPTS = --ext-viewcode
APIDOC_EXCLUDES = */tests */tests/* */*/tests/* */*/*/tests/* APIDOC_EXCLUDES = */tests */tests/* */*/tests/* */*/*/tests/*
APIDOC_EXCLUDES += */migrations */migrations/* */*/migrations/* */*/*/migrations/* APIDOC_EXCLUDES += */migrations */migrations/* */*/migrations/* */*/*/migrations/*
APIDOC_EXCLUDES += */wsgi.py */*/wsgi.py */*/*/wsgi.py */*/*/wsgi.py APIDOC_EXCLUDES += */wsgi.py */*/wsgi.py */*/*/wsgi.py */*/*/wsgi.py
APIDOC_SWH_EXCLUDES = $(patsubst %,$(SWHPKGDIR)/%,$(APIDOC_EXCLUDES)) APIDOC_SWH_EXCLUDES = $(patsubst %,$(SWHPKGDIR)/%,$(APIDOC_EXCLUDES))
html: sphinx/html html: sphinx/html
sphinx/html: links-stamp apidoc-stamp images-stamp rec-build-stamp sphinx/html: links-stamp apidoc-stamp images-stamp rec-build-stamp
links-stamp: links-stamp:
bin/ln-sphinx-subprojects bin/ln-sphinx-subprojects
touch $@ touch $@
apidoc: apidoc-stamp apidoc: apidoc-stamp
apidoc-stamp: images-stamp apidoc-stamp: links-stamp images-stamp
$(SPHINXAPIDOC) $(APIDOC_OPTS) -o $(APIDOC_DIR) $(SWHPKGDIR) $(APIDOC_SWH_EXCLUDES) $(SPHINXAPIDOC) --implicit-namespaces $(APIDOC_OPTS) -o $(APIDOC_DIR) $(SWHPKGDIR) $(APIDOC_SWH_EXCLUDES)
touch $@ touch $@
images-stamp: images-stamp:
$(MAKE) -C images $(MAKE) -C images
touch $@ touch $@
# Build documentation recursively in all packages, to make sure that auxiliary, # Build documentation recursively in all packages, to make sure that auxiliary,
# non-sphinx managed documentation artifacts (e.g., schema diagrams) are also # non-sphinx managed documentation artifacts (e.g., schema diagrams) are also
Show All 31 Lines
View Options

docs/bin/ln-sphinx-subprojects

#!/bin/bash #!/bin/bash
set -e set -e
create_links () { create_links () {
anlambertUnsubmitted
Done
Inline Actions

mkdir sources should be sufficient here as the swh directory will be created by the cp -fr command below

anlambert: `mkdir sources` should be sufficient here as the `swh` directory will be created by the `cp…
mkdir -p sources/swh/
for pymodule in $(cd ../../ && bin/ls-py-modules) ; do for pymodule in $(cd ../../ && bin/ls-py-modules) ; do
if [ "$pymodule" = 'swh-docs' ] ; then if [ "$pymodule" = 'swh-docs' ] ; then
continue continue
fi fi
if [ ! -e "$pymodule" -a -d "../../${pymodule}/docs" ] ; then if [ ! -e "$pymodule" -a -d "../../${pymodule}/docs" ] ; then
ln -s "../../${pymodule}/docs" "$pymodule" ln -s "../../${pymodule}/docs" "$pymodule"
fi fi
if [ -d "../../${pymodule}/swh" ] ; then
cp -fr --link "../../${pymodule}/swh/" "sources/"
fi
done done
} }
remove_links () { remove_links () {
for pymodule in $(cd ../../ && bin/ls-py-modules) ; do for pymodule in $(cd ../../ && bin/ls-py-modules) ; do
if [ "$pymodule" = 'swh-docs' ] ; then if [ "$pymodule" = 'swh-docs' ] ; then
continue continue
fi fi
if [ -L "$pymodule" ] ; then if [ -L "$pymodule" ] ; then
rm "$pymodule" rm "$pymodule"
fi fi
done done
rm -rf sources
} }
if [ "$1" = "--remove" ] ; then if [ "$1" = "--remove" ] ; then
remove_links remove_links
else else
create_links create_links
fi fi
About · Developer information · Legal