Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
soledad
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
GitLab community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Satyam Saxena
soledad
Commits
080e59ed
Unverified
Commit
080e59ed
authored
Oct 11, 2017
by
drebs
Browse files
Options
Downloads
Patches
Plain Diff
[doc] add script to build docs
parent
5a6d04ca
No related branches found
No related tags found
No related merge requests found
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
Makefile
+6
-0
6 additions, 0 deletions
Makefile
scripts/docs/build-soledad-doc.sh
+47
-0
47 additions, 0 deletions
scripts/docs/build-soledad-doc.sh
with
53 additions
and
0 deletions
Makefile
+
6
−
0
View file @
080e59ed
...
...
@@ -3,3 +3,9 @@ default:
upload_packages
:
python setup.py sdist bdist_wheel
--universal
upload
--sign
-i
$(
MAINTAINER
)
-r
pypi
docs
:
(
cd
docs
&&
make html
)
docs-using-virtualenv
:
./scripts/docs/build-soledad-doc.sh
This diff is collapsed.
Click to expand it.
scripts/docs/build-soledad-doc.sh
0 → 100755
+
47
−
0
View file @
080e59ed
#!/bin/sh
# This script builds the Soledad documentation using a virtual environment.
# You can pass the target directory as the first command line argument:
#
# ./build-soledad-doc.sh [target-dir]
#
# If you no directory is passed, documentation will be built on the default
# place used by sphinx: <repodir>/docs/_build
set
-eu
set
-o
xtrace
BUILDDIR
=
${
1
:-
_build
}
REPO
=
"http://0xacab.org/leap/soledad"
REPO
=
/tmp/soledad
TEMPDIR
=
$(
mktemp
-d
)
VENVDIR
=
${
TEMPDIR
}
/venv
REPODIR
=
${
TEMPDIR
}
/soledad
TARGET
=
html
if
[[
${
BUILDDIR
}
=
/
*
]]
;
then
type
=
"absolute"
docdir
=
${
BUILDDIR
}
/
${
TARGET
}
else
type
=
"relative"
docdir
=
${
REPODIR
}
/docs/
${
BUILDDIR
}
/
${
TARGET
}
fi
echo
"Documentation will be written to
${
type
}
path
${
BUILDDIR
}
."
# build and activate the virtual environment
if
[
!
-d
${
VENVDIR
}
]
;
then
virtualenv
${
VENVDIR
}
fi
.
${
VENVDIR
}
/bin/activate
# clone the canonical repository
git clone
${
REPO
}
${
REPODIR
}
# install deps
pip
install
-U
pip wheel
pip
install
-r
${
REPODIR
}
/docs/requirements.pip
# build documentation
make
-C
${
REPODIR
}
/docs
${
TARGET
}
BUILDDIR
=
${
BUILDDIR
}
ls
-1
${
docdir
}
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment