trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From pa...@apache.org
Subject [trafficserver] branch master updated: Update doc building instructions
Date Fri, 14 Apr 2017 21:30:01 GMT
This is an automated email from the ASF dual-hosted git repository.

paziz 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  3093a20   Update doc building instructions
3093a20 is described below

commit 3093a20ea54170bc92d1876efe00a819db82ec99
Author: Daniel Xu <danobi@users.noreply.github.com>
AuthorDate: Fri Apr 14 14:55:03 2017 -0500

    Update doc building instructions
    
    Few reasons why this change is needed:
      - the `--enable-docs` switch is easy to forget.
      - the Vagrant config doesn't even set up sphinx
      - not having the python sphinx package installed generates
        very ambiguous error messages
---
 doc/developer-guide/documentation/building.en.rst | 7 ++-----
 1 file changed, 2 insertions(+), 5 deletions(-)

diff --git a/doc/developer-guide/documentation/building.en.rst b/doc/developer-guide/documentation/building.en.rst
index 6ba5d1c..220762c 100644
--- a/doc/developer-guide/documentation/building.en.rst
+++ b/doc/developer-guide/documentation/building.en.rst
@@ -24,11 +24,8 @@ Building the Documentation
 
 All documentation and related files are located in the source tree under the
 ``doc/`` directory. Makefiles are generated automatically by the main configure
-script. For simplicity's sake, it is recommended that contributors new to the
-documentation make use of the included Vagrant configurations, as these will
-take care of providing all dependencies. Please refer to the
-:ref:`developer-testing-with-vagrant` chapter for complete details on using
-Vagrant to build and test the |TS| source tree.
+script. The current configure script switch for enabling documentation builds is
+``--enable-docs``. Also make sure you have run ``pip install sphinx`` at some point.
 
 With a configured source tree, building the documentation requires only the
 invocation ``make html`` from within ``doc/``. For repeated builds while working

-- 
To stop receiving notification emails like this one, please contact
['"commits@trafficserver.apache.org" <commits@trafficserver.apache.org>'].

Mime
View raw message