Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
D
doctrine-dbal
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Tomáš Trávníček
doctrine-dbal
Commits
c079d137
Commit
c079d137
authored
Sep 10, 2015
by
Steve Müller
Browse files
Options
Browse Files
Download
Plain Diff
Merge pull request #901 from zeroedin-bill/docs-build-improvements
Update docs dep script and readme to target Ubuntu 14.04
parents
641ad645
1369b0f4
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
16 additions
and
8 deletions
+16
-8
README.md
docs/README.md
+12
-2
install-dependencies.sh
docs/bin/install-dependencies.sh
+1
-3
conf.py
docs/en/conf.py
+3
-3
No files found.
docs/README.md
View file @
c079d137
# Doctrine DBAL Documentation
## How to Generate
## How to Generate:
Using Ubuntu 14.04 LTS:
1.
Run ./bin/install-dependencies.sh
2.
Run ./bin/generate-docs.sh
It will generate the documentation into the build directory of the checkout.
\ No newline at end of file
It will generate the documentation into the build directory of the checkout.
## Theme issues
If you get a "Theme error", check if the
`en/_theme`
subdirectory is empty,
in which case you will need to run:
1.
git submodule init
2.
git submodule update
\ No newline at end of file
docs/bin/install-dependencies.sh
View file @
c079d137
#!/bin/bash
sudo
apt-get
install
python25 python25-dev texlive-full rubber
sudo
easy_install pygments
sudo
easy_install sphinx
\ No newline at end of file
sudo
apt-get update
&&
sudo
apt-get
install
-y
python2.7 python-sphinx python-pygments
\ No newline at end of file
docs/en/conf.py
View file @
c079d137
...
...
@@ -38,16 +38,16 @@ master_doc = 'index'
# General information about the project.
project
=
u'Doctrine DBAL'
copyright
=
u'2010, Roman Borschel, Guilherme Blanco, Benjamin Eberlei, Jonathan Wage'
copyright
=
u'2010
-2015
, Roman Borschel, Guilherme Blanco, Benjamin Eberlei, Jonathan Wage'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version
=
'2
.1
'
version
=
'2'
# The full version, including alpha/beta/rc tags.
release
=
'2
.1.0
'
release
=
'2'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment