Permalink
18653d9 Mar 4, 2016
@dlavigne @vvheritagevv @baitisj @kmoore134
93 lines (66 sloc) 4.64 KB

The PC-BSD Users Handbook is generated from ASCII text files, that end in a .rst extension, within the PC-BSD source repository. The PC-BSD Project uses the Sphinx Python documentation generator to generate the documentation. Anyone can download the documentation source and generate their own copy of the documentation in HTML or PDF formats. Users with a github account can also edit the documentation and generate git pull requests so that the edits can be reviewed and committed. This README contains instructions for getting the source, generating a copy of the documentation, and issuing a git pull request. It assumes that the reader is using these instructions on either a PC-BSD system or a FreeBSD jail.

Requirements:

At a minimum, the following software needs to be installed as the root/superuser. If this is the first time you have used pkg on the system, it may prompt you to fetch and install it. Say yes to the prompts to do so. Once it is finished, you can then finish installing the needed software.

Instructions are given for both the port and the package as some software may not have a package. Try the pkg command first as it is faster. If the pkg command succeeds, you do not need to run the make command as the software is already installed; however if it fails, use the make command to install the software. If the software is already installed, the pkg command will indicate that the most recent version is already installed.

PC-BSD users can alternately install the pcbsd-toolchain package using AppCafe as it contains all of the necessary packages.

portsnap fetch extract
pkg install devel/git (cd /usr/ports/devel/git/ && make install)
pkg install textproc/py-sphinx (cd /usr/ports/textproc/py-sphinx/ && make install)
pkg install textproc/py-sphinxcontrib-httpdomain (cd /usr/ports/textproc/py-sphinxcontrib-httpdomain && make install)
pkg install textproc/py-sphinx_numfig (cd /usr/ports/textproc/py-sphinx_numfig && make install)
pkg install textproc/py-sphinx_wikipedia (cd /usr/ports/textproc/py-sphinx_wikipedia && make install)
rehash

If you wish to generate a PDF version of the documentation, this software also needs to be installed:

pkg install print/tex-formats (cd /usr/ports/print/tex-formats/ && make install)
pkg install print/tex-dvipsk (cd /usr/ports/print/tex-dvipsk/ && make install)
pkg install devel/gmake (/usr/ports/devel/gmake/ && make install)

Next, determine where you want to store the source code and change to that directory (we'll refer to it as /path/to/your-build-directory). Then, check out the source code from git:

cd /path/to/your-build-directory
git clone git://github.com/pcbsd/pcbsd.git
cd pcbsd/src-qt5/docs/

Building the Documentation

All of the following commands need to be run from /path/to/your-build-directory/pcbsd/src-qt5/docs/. These formats are currently available: HTML, single HTML, PDF, and EPUB. The output of either HTML can be found in /path/to/your-build-directory/pcbsd/src-qt5/docs/_build/ and can be viewed in a web browser. The PDF output will be found in /path/to/your-build-directory/pcbsd/src-qt5/docs/_build/latex/PCBSD.pdf. The EPUB output will be found in /path/to/your-build-directory/pcbsd/src-qt5/docs/_build/pcbsd_userguide.epub.

To build a local copy of the HTML, with a separate page for each chapter and that chapter's table of contents in the left frame with navigational links to browse between chapters, run the following command:

sphinx-build -b html . _build

To build a local copy of the HTML as one long page, with the entire table of contents in the left frame, use this command instead:

sphinx-build -b singlehtml . _build

To build a local PDF, run this command TWICE and ignore its error messages:

yes '' | gmake latexpdf
yes '' | gmake latexpdf

To build a local EPUB, run this command:

sphinx-build -b epub . _build

Editing the Documentation

If you want to edit the User Guide, make changes to the *.rst file for the chapter to edit, using any ASCII text editor. Refer to the Quick reStructuredText guide for help with formatting syntax. Also refer to this list of reST editors.

Some very helpful tools for editing the documentation are listed below by editor.

Vim:

Need help getting started or want to discuss edits? Join the http://lists.pcbsd.org/mailman/listinfo/docs mailing list.

To issue a git pull request containing your edits, use the instructions at https://help.github.com/articles/using-pull-requests.