Update layout
This commit is contained in:
parent
8954d1e013
commit
ba534e264d
5 changed files with 44 additions and 72 deletions
|
|
@ -24,8 +24,6 @@ help:
|
||||||
@echo " pickle to make pickle files"
|
@echo " pickle to make pickle files"
|
||||||
@echo " json to make JSON files"
|
@echo " json to make JSON files"
|
||||||
@echo " htmlhelp to make HTML files and a HTML help project"
|
@echo " htmlhelp to make HTML files and a HTML help project"
|
||||||
@echo " qthelp to make HTML files and a qthelp project"
|
|
||||||
@echo " devhelp to make HTML files and a Devhelp project"
|
|
||||||
@echo " epub to make an epub"
|
@echo " epub to make an epub"
|
||||||
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
||||||
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
||||||
|
|
@ -72,24 +70,6 @@ htmlhelp:
|
||||||
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
||||||
".hhp project file in $(BUILDDIR)/htmlhelp."
|
".hhp project file in $(BUILDDIR)/htmlhelp."
|
||||||
|
|
||||||
qthelp:
|
|
||||||
$(SPHINXBUILD) -W -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
|
||||||
@echo
|
|
||||||
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
|
||||||
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
|
||||||
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PHPXPDF.qhcp"
|
|
||||||
@echo "To view the help file:"
|
|
||||||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PHPXPDF.qhc"
|
|
||||||
|
|
||||||
devhelp:
|
|
||||||
$(SPHINXBUILD) -W -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
|
||||||
@echo
|
|
||||||
@echo "Build finished."
|
|
||||||
@echo "To view the help file:"
|
|
||||||
@echo "# mkdir -p $$HOME/.local/share/devhelp/PHPXPDF"
|
|
||||||
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PHPXPDF"
|
|
||||||
@echo "# devhelp"
|
|
||||||
|
|
||||||
epub:
|
epub:
|
||||||
$(SPHINXBUILD) -W -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
$(SPHINXBUILD) -W -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
||||||
@echo
|
@echo
|
||||||
|
|
|
||||||
14
docs/make.bat
Normal file → Executable file
14
docs/make.bat
Normal file → Executable file
|
|
@ -24,8 +24,6 @@ if "%1" == "help" (
|
||||||
echo. pickle to make pickle files
|
echo. pickle to make pickle files
|
||||||
echo. json to make JSON files
|
echo. json to make JSON files
|
||||||
echo. htmlhelp to make HTML files and a HTML help project
|
echo. htmlhelp to make HTML files and a HTML help project
|
||||||
echo. qthelp to make HTML files and a qthelp project
|
|
||||||
echo. devhelp to make HTML files and a Devhelp project
|
|
||||||
echo. epub to make an epub
|
echo. epub to make an epub
|
||||||
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
|
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
|
||||||
echo. text to make text files
|
echo. text to make text files
|
||||||
|
|
@ -93,18 +91,6 @@ if "%1" == "htmlhelp" (
|
||||||
goto end
|
goto end
|
||||||
)
|
)
|
||||||
|
|
||||||
if "%1" == "qthelp" (
|
|
||||||
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
|
|
||||||
if errorlevel 1 exit /b 1
|
|
||||||
echo.
|
|
||||||
echo.Build finished; now you can run "qcollectiongenerator" with the ^
|
|
||||||
.qhcp project file in %BUILDDIR%/qthelp, like this:
|
|
||||||
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\PHPXPDF.qhcp
|
|
||||||
echo.To view the help file:
|
|
||||||
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\PHPXPDF.ghc
|
|
||||||
goto end
|
|
||||||
)
|
|
||||||
|
|
||||||
if "%1" == "devhelp" (
|
if "%1" == "devhelp" (
|
||||||
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
|
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
|
||||||
if errorlevel 1 exit /b 1
|
if errorlevel 1 exit /b 1
|
||||||
|
|
|
||||||
|
|
@ -161,9 +161,9 @@
|
||||||
<!--<div class="nav-collapse" id="navigation" class="related">
|
<!--<div class="nav-collapse" id="navigation" class="related">
|
||||||
{{ toctree(collapse=True, maxdepth=-1, titles_only=False) }}
|
{{ toctree(collapse=True, maxdepth=-1, titles_only=False) }}
|
||||||
</div>-->
|
</div>-->
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
<a href="{{ github_repo }}">
|
||||||
<a href="https://github.com/alchemy-fr/PHP-FFmpeg/">
|
|
||||||
<img style="z-index:1200;position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub">
|
<img style="z-index:1200;position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub">
|
||||||
</a>
|
</a>
|
||||||
</div>
|
</div>
|
||||||
|
|
@ -171,7 +171,7 @@
|
||||||
|
|
||||||
<div class="row-fluid">
|
<div class="row-fluid">
|
||||||
<div class="span4">
|
<div class="span4">
|
||||||
<img src="{{ pathto('_static/img/ffmpeg.png', 1) }}"/>
|
<img src="{{ pathto('_static/img/project.png', 1) }}"/>
|
||||||
{{ sidebar() }}
|
{{ sidebar() }}
|
||||||
</div>
|
</div>
|
||||||
<div class="span8">
|
<div class="span8">
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,5 @@
|
||||||
import sys, os
|
import sys, os
|
||||||
|
import os.path
|
||||||
|
|
||||||
# If extensions (or modules to document with autodoc) are in another directory,
|
# If extensions (or modules to document with autodoc) are in another directory,
|
||||||
# add these directories to sys.path here. If the directory is relative to the
|
# add these directories to sys.path here. If the directory is relative to the
|
||||||
|
|
@ -228,38 +229,6 @@ texinfo_documents = [
|
||||||
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||||
#texinfo_show_urls = 'footnote'
|
#texinfo_show_urls = 'footnote'
|
||||||
|
|
||||||
|
current_dir = os.path.dirname(os.path.abspath(__file__))
|
||||||
|
sys.path.append(current_dir)
|
||||||
# project name
|
from local_conf import *
|
||||||
project = u'PHP-FFMpeg'
|
|
||||||
|
|
||||||
# Tex info conf
|
|
||||||
texinfo_documents = [
|
|
||||||
('index', 'PHP-FFMpeg', u'PHP-FFMpeg Documentation',
|
|
||||||
u'Romain Neutron - Alchemy', 'PHP-FFMpeg', 'One line description of project.',
|
|
||||||
'Miscellaneous'),
|
|
||||||
]
|
|
||||||
|
|
||||||
# Man page conf
|
|
||||||
man_pages = [
|
|
||||||
('index', 'phpffmpeg', u'PHP-FFMpeg name Documentation',
|
|
||||||
[u'Romain Neutron - Alchemy'], 1)
|
|
||||||
]
|
|
||||||
|
|
||||||
# Latex doc conf
|
|
||||||
latex_documents = [
|
|
||||||
('index', 'PHPFFMpeg.tex', u'PHP-FFMpeg Documentation',
|
|
||||||
u'Romain Neutron - Alchemy', 'manual'),
|
|
||||||
]
|
|
||||||
|
|
||||||
# html help basename
|
|
||||||
htmlhelp_basename = 'PHPFFMpegdoc'
|
|
||||||
|
|
||||||
# version
|
|
||||||
version = '0.1'
|
|
||||||
|
|
||||||
# release
|
|
||||||
release = '0.1'
|
|
||||||
|
|
||||||
# Copyright Value ex : copyright = u'2012, Alchemy'
|
|
||||||
copyright = u'2012, Romain Neutron - Alchemy'
|
|
||||||
|
|
|
||||||
37
docs/source/local_conf.py
Normal file
37
docs/source/local_conf.py
Normal file
|
|
@ -0,0 +1,37 @@
|
||||||
|
|
||||||
|
# project name
|
||||||
|
project = u'Project Name'
|
||||||
|
|
||||||
|
#github repository URL
|
||||||
|
github_repo = ''
|
||||||
|
|
||||||
|
# Tex info conf
|
||||||
|
texinfo_documents = [
|
||||||
|
('index', 'Project name', u'Project Documentation',
|
||||||
|
u'Copyright holder', 'Project name', 'One line description of project.',
|
||||||
|
'Miscellaneous'),
|
||||||
|
]
|
||||||
|
|
||||||
|
# Man page conf
|
||||||
|
man_pages = [
|
||||||
|
('index', 'projectname', u'PProject name Documentation',
|
||||||
|
[u'Copyright holder'], 1)
|
||||||
|
]
|
||||||
|
|
||||||
|
# Latex doc conf
|
||||||
|
latex_documents = [
|
||||||
|
('index', 'ProjectName.tex', u'Project Name Documentation',
|
||||||
|
u'Copyright holder', 'manual'),
|
||||||
|
]
|
||||||
|
|
||||||
|
# html help basename
|
||||||
|
htmlhelp_basename = 'PROJECTdoc'
|
||||||
|
|
||||||
|
# version
|
||||||
|
version = '0.1'
|
||||||
|
|
||||||
|
# release
|
||||||
|
release = '0.1'
|
||||||
|
|
||||||
|
# Copyright Value ex : copyright = u'2012, Alchemy'
|
||||||
|
copyright = u'2012, Alchemy'
|
||||||
Loading…
Add table
Add a link
Reference in a new issue