build-site.py

Archives Ansible Project
1

Is build-site.py brocken, or am I missing something?
I do:

     cd docsite
     ./build-site.py

Then the modules.html does not include any of the module....

Thanks.

2

Is build-site.py brocken, or am I missing something?
I do:

    cd docsite
    ./build-site.py

Then the modules.html does not include any of the module....

You should be able to `make docs' from the main directory; works here.

        -JP

3

Weird... I get this error for every module:
     rst/modules/_list.rst:2: (SEVERE/4) Problems with "include" directive path:
     IOError: [Errno 2] No such file or directory: 'rst/modules/modules/add_host.rst'.

Notice the directory "modules" is repeated twice. I just added a soft link in modules to itself, it gets me by to be able to look at the html output, which is all I want for now. But still, I wonder what I'm doing wrong.

4

try

source ./hacking/env-setup

before you build?

5

Is build-site.py brocken, or am I missing something?
I do:

      cd docsite
      ./build-site.py

Then the modules.html does not include any of the module....

You should be able to `make docs' from the main directory; works here.

Weird... I get this error for every module:
     rst/modules/_list.rst:2: (SEVERE/4) Problems with "include" directive
path:
     IOError: [Errno 2] No such file or directory:
'rst/modules/modules/add_host.rst'.

Notice the directory "modules" is repeated twice. I just added a soft link
in modules to itself, it gets me by to be able to look at the html output,
which is all I want for now. But still, I wonder what I'm doing wrong.

source ./hacking/env-setup

before you build?

Thanks for all the suggestions. I had a lot of left over files from previous make runs, I completely clean my repo until I got a clean "git pull upstream", and now it builds the docs correctly.

6

Is there an undocumented dependence on Sphinx for “make docs” and “make deb”? I’m on Ubuntu 12.04 and would get this error for both make commands:

[lines removed]
make[1]: Entering directory /home/ops/src/ansible/docsite' [lines removed] processing module source ---> ../library/yum processing module source ---> ../library/zfs ./build-site.py Traceback (most recent call last): File "./build-site.py", line 24, in <module> from sphinx.application import Sphinx ImportError: No module named sphinx.application make[1]: *** [docs] Error 1 make[1]: Leaving directory /home/ops/src/ansible/docsite’
make: *** [webdocs] Error 2

After installing the Ubuntu package “python-sphinx” (and its dependencies) Sphinx was invoked and the builds were successful.

Thanks,

-Greg

7

Yes, if someone wants, we can add this to the getting started docs.

Just send a pull request for the files in docsite/rst/*.rst !