Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
K
kwant
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
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Joseph Weston
kwant
Commits
6e31c92a
Commit
6e31c92a
authored
11 years ago
by
Christoph Groth
Browse files
Options
Downloads
Patches
Plain Diff
docs: use rsvg-convert instead of inkscape (less dependencies), mention this in INSTALL
parent
97eb1c81
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
INSTALL
+8
-5
8 additions, 5 deletions
INSTALL
doc/Makefile
+1
-1
1 addition, 1 deletion
doc/Makefile
with
9 additions
and
6 deletions
INSTALL
+
8
−
5
View file @
6e31c92a
...
...
@@ -469,16 +469,19 @@ Building the documentation
==========================
To build the documentation, Kwant has to be installed as described above.
Additionally, the `sphinx documentation generator <http://sphinx.pocoo.org/>`_
is required.
Additionally, the `Sphinx documentation generator <http://sphinx.pocoo.org/>`_
is required. If PDF documentation is to be built, the tools from the `libRSVG
<http://live.gnome.org/LibRsvg>`_ (Debian/Ubuntu package ``librsvg2-bin``) are
needed to convert SVG drawings into the PDF format.
HTML documentation
can be
built by entering the ``doc`` subdirectory of the
HTML documentation
is
built by entering the ``doc`` subdirectory of the
Kwant package and executing ``make html``. PDF documentation is generated by
executing ``make latex`` followed by a ``make all-pdf`` in ``doc/build/latex``.
Because of some quirks of how
s
phinx works, it might be necessary to execute
Because of some quirks of how
S
phinx works, it might be necessary to execute
``make clean`` between building HTML and PDF documentation. If this is not
done, sphinx might mistakenly use PNG files for PDF output.
done, Sphinx might mistakenly use PNG files for PDF output or other problems may
appear.
Hacking
...
...
This diff is collapsed.
Click to expand it.
doc/Makefile
+
1
−
1
View file @
6e31c92a
...
...
@@ -120,7 +120,7 @@ doctest:
"results in
$(
BUILDDIR
)
/doctest/output.txt."
%.pdf
:
%.svg
inkscape
--export-pdf
=
$@
$<
rsvg-convert
-f
pdf
-o
$@
$<
# Make the image generation scripts by patching tutorial scipts.
.SECONDARY
:
...
...
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