You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by ma...@apache.org on 2019/06/13 22:43:27 UTC
[trafficserver] branch master updated: Add Pipfile for building docs
This is an automated email from the ASF dual-hosted git repository.
masaori pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficserver.git
The following commit(s) were added to refs/heads/master by this push:
new 07ca9b0 Add Pipfile for building docs
07ca9b0 is described below
commit 07ca9b0360e2fd112d27b2f993e3ee508a92f849
Author: Masaori Koshiba <ma...@apache.org>
AuthorDate: Mon Jun 10 11:17:04 2019 +0900
Add Pipfile for building docs
---
doc/.gitignore | 1 +
doc/Pipfile | 38 +++++++++++++++++++++++
doc/developer-guide/documentation/building.en.rst | 7 +++++
doc/pip_requirements.txt | 5 ---
4 files changed, 46 insertions(+), 5 deletions(-)
diff --git a/doc/.gitignore b/doc/.gitignore
index 518a1af..21ee9ce 100644
--- a/doc/.gitignore
+++ b/doc/.gitignore
@@ -1,3 +1,4 @@
uml/images
ext/local-config.py
ext/plantuml*
+Pipfile.lock
diff --git a/doc/Pipfile b/doc/Pipfile
new file mode 100644
index 0000000..78be762
--- /dev/null
+++ b/doc/Pipfile
@@ -0,0 +1,38 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+[[source]]
+name = "pypi"
+url = "https://pypi.org/simple"
+verify_ssl = true
+
+[dev-packages]
+
+[packages]
+sphinx = "*"
+sphinx-rtd-theme = "*"
+sphinxcontrib-plantuml = "*"
+# i18n
+sphinx-intl = "*"
+
+# For parsing Doxygen XML output, to add links from an API description
+# to the source code for that object
+lxml = "*"
+
+polib = ">=1.0.3"
+
+[requires]
+python_version = "3"
diff --git a/doc/developer-guide/documentation/building.en.rst b/doc/developer-guide/documentation/building.en.rst
index 0e98329..9e5cedc 100644
--- a/doc/developer-guide/documentation/building.en.rst
+++ b/doc/developer-guide/documentation/building.en.rst
@@ -60,6 +60,13 @@ PIP installs
Internation support, which is needed if a non-English version is built. Currently a Japanese
(``JA``) version is available.
+ These should be also installed using `pipenv
+ <https://docs.pipenv.org/>`__ and :ts:git:`doc/Pipfile`. To setup the environment, run below commands from within the :ts:git:`doc/` directory of the |TS| source tree::
+
+ pipenv install
+ pipenv shell
+
+
With a configured source tree, building the documentation requires only the
invocation ``make html`` from within ``doc/``. For repeated builds while working
on the documentation doing ``make html`` again is sufficient. After fixing all warnings / errors,
diff --git a/doc/pip_requirements.txt b/doc/pip_requirements.txt
deleted file mode 100644
index 099cf4a..0000000
--- a/doc/pip_requirements.txt
+++ /dev/null
@@ -1,5 +0,0 @@
-# For parsing Doxygen XML output, to add links from an API description
-# to the source code for that object
-lxml
-
-polib>=1.0.3