[TYPO3-doc] [!!!][NEW] T3PythonDocBuilder package available - two params to get it all!

[Martin Bless]

Fabien,

((already sent by PM with some colored parts))

>Hi Martin,
>
>I have just tested your script and it seems it has worked out. It looks I can integrate in the
>rendering Workflow.
>
>Besides that, can you refresh my memory, do you have another script for rendering regular reST
>documentation in the same way. You know, Documentation/Index.rst. Thanks for your pointer.
>
>Reference: https://forge.typo3.org/issues/40019
>
>Fb.

Do I have that script? Yes and now. In this case we assume that we are
on our server where the stuff from RestTools.git ("t3sphinx") has been
installed by "python .../setup.py install". On server srv123 this is the
case. I have done this.

And then I'm doing it this way:
http://srv123.typo3.org/~mbless/git.typo3.org/Documentation/TYPO3/Example/OfficialManual.git.make/cron_rebuild.sh

It's just a matter of a shell script, no Python stuff involved. It is
mainly:
- go to the right folder
- pull latest master
- call the normal "make html" and so on of Sphinx.

Now, with my "poor man's task queue" there is a special file "Makefile"
for each project. For example:

# You can set these variables from the command line.
SPHINXOPTS    = -c . -a -E -w warnings.txt
SPHINXBUILD   = sphinx-build
PAPER         =
BUILDDIR      = /home/mbless/public_html/TYPO3/OfficialManualExample

# Internal variables.
PAPEROPT_a4     = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER))
$(SPHINXOPTS) ../OfficialManual.git/Documentation
# the i18n builder cannot share the environment and doctrees with the
others
I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS)
../OfficialManual.git/Documentation


I also changed the actual BUILDDIR for 'html'

from:

html:
	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
	@echo
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."



to:


html:
	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)
	@echo
	@echo "Build finished. The HTML pages are in $(BUILDDIR)."


You probably should consider the strings formatted in red as variables
you should provide. Ok? 


Addition:


> It's just a matter of a shell script, no Python stuff involved. It is mainly:
> - go to the right folder
> - pull latest master
> - call the normal "make html" and so on of Sphinx.


Some more changes from 2012-09-26:

1.
This folder can function as a model:
http://srv123.typo3.org/~mbless/git.typo3.org/Documentation/TYPO3/Reference/CoreApi.git.make/

2.
In that "conf.py" these lines are "variable" as well and need to be
defined:
    t3DocTeam['relpath_to_master_doc'] = '..'
    t3DocTeam['relpath_to_master_doc'] = '../CoreApi.git/Documentation'
    t3DocTeam['relpath_to_logdir'] = '_not_versioned'
    t3DocTeam['relpath_to_logdir'] = '.'

We have to find out how to do it.

3.
Another change in "Makefile":

clean:
	-rm objects.inv
	-cp -p $(BUILDDIR)/objects.inv .
	-rm -rf $(BUILDDIR)/*
	-rm -rf $(BUILDDIR)/.buildinfo
	-cp -p objects.inv $(BUILDDIR)


Sail on ...

Martin

-- 
Certified TYPO3 Integrator | TYPO3 Documentation Team Member

http://mbless.de