Commit graph

391 commits

Author SHA1 Message Date
Klaas Freitag
c58e9d17a8 Again minor doc changes. 2013-11-07 10:29:27 +01:00
Klaas Freitag
41ccbc0334 Minor docu change. 2013-11-07 10:28:14 +01:00
Klaas Freitag
b6152c19d6 Adjust generic build documentation to the current state. 2013-11-06 11:13:55 +01:00
Andrea Sosso
083e75998f Update mingw32-cross-nsis-plugin-processes and mingw32-cross-nsis-plugin-uac 2013-10-28 17:17:10 +01:00
Mathieu Arnold
2b652422b9 Don't call make directly, it can have another name. 2013-10-16 15:57:05 +02:00
hefee
2b1602872c Don't ship doc/scripts/README.rst via sphinx 2013-09-13 01:26:02 +02:00
Daniel Molkentin
b488ad12c2 Do not build org and com theming when building from tar ball
Fixes #989
2013-09-12 12:56:24 +02:00
morriswinkler
751181d14f Update building.rst
eider fix it or add the note here
2013-09-09 19:09:08 +02:00
Klaas Freitag
8fe102662d Merge branch 'propagator-ng': Fixes to work with new LGPL ocsync.
Conflicts:
	src/mirall/csyncthread.cpp
2013-09-04 16:33:06 +02:00
Klaas Freitag
b676ffe208 Some more info about the exclude matching. 2013-09-04 15:17:43 +02:00
Daniel Molkentin
da63b1223c Doc: more polishing
- add description of syncing limitations
- update out-of-date comments

Fixes #788
2013-09-03 12:35:40 +02:00
Daniel Molkentin
063acadc3b Doc: new interface chapter 2013-09-02 19:28:06 +02:00
Daniel Molkentin
5df6430bb2 Doc: Do not enforce theme when building without submodules 2013-09-02 15:55:03 +02:00
Daniel Molkentin
9a0096d07c Docs: Allow to build with org and com branding 2013-09-02 14:01:15 +02:00
Klaas Freitag
98efab83a1 Compile against ocsync based on csync 0.50 2013-08-20 13:26:03 +02:00
hefee
066c0ba189 Make building documantation parallelable.
sphinx will fail in a race condition, if every sphinx target
uses the same CACHE dir:

Exception occurred:
	File "/usr/lib/pymodules/python2.7/sphinx/cmdline.py", line 189, in main
app.build(force_all, filenames)
	File "/usr/lib/pymodules/python2.7/sphinx/application.py", line 204, in build
self.builder.build_update()
	File "/usr/lib/pymodules/python2.7/sphinx/builders/__init__.py", line 196, in build_update
	'out of date' % len(to_build))
	File "/usr/lib/pymodules/python2.7/sphinx/builders/__init__.py", line 238, in build
self.env.topickle(path.join(self.doctreedir, ENV_PICKLE_FILENAME))
	File "/usr/lib/pymodules/python2.7/sphinx/environment.py", line 351, in topickle
	movefile(filename + '.tmp', filename)
	File "/usr/lib/pymodules/python2.7/sphinx/util/osutil.py", line 104, in movefile
os.rename(source, dest)
	OSError: [Errno 2] No such file or directory
2013-08-15 02:36:44 +02:00
Daniel Molkentin
95d600c5f1 Fix proxy documentation, explain bandwidth limiter 2013-08-08 14:54:52 +02:00
Klaas Freitag
4e7c069c1f Some adds to the architecture documentation. 2013-08-08 14:19:13 +02:00
Klaas Freitag
18f764e4d5 Fix a typo. 2013-08-02 21:55:09 +02:00
RealRancor
33d76962a7 Updated options with missing cl switches 2013-08-02 11:59:57 +02:00
Klaas Freitag
5da6103fb5 Documented the docexpire option. 2013-07-11 12:32:58 +02:00
Daniel Molkentin
a441b1d562 Bump year 2013-06-19 16:07:07 +02:00
Daniel Molkentin
6e2042cd55 Doc: Expand usage page 2013-06-19 16:04:48 +02:00
Daniel Molkentin
bb8b58dc66 Doc: more fixes on troubleshooting section 2013-06-19 15:48:04 +02:00
Daniel Molkentin
9cd099056b Doc: More structure in troubleshooting.rst 2013-06-19 15:40:20 +02:00
Daniel Molkentin
0adbc032ae Doc: Expand trouble shooting section 2013-06-19 15:40:15 +02:00
Daniel Molkentin
22a679fb8c Doc: Add back --logfile, as it still exists 2013-06-19 15:40:09 +02:00
Daniel Molkentin
35a67fab0a Doc: remove now meaningless scentences 2013-06-19 15:40:06 +02:00
Daniel Molkentin
fdc8117211 doc: Fix wording 2013-06-19 15:40:02 +02:00
Daniel Molkentin
24208e6137 Remove mirall man page 2013-06-19 15:39:56 +02:00
Daniel Molkentin
205502fd3b Fix incorrect license attribution
Fixes #672
2013-06-10 07:42:35 +02:00
Daniel Molkentin
79785241ea Docs: --logdir replaces --logfile 2013-06-05 14:57:32 +02:00
Daniel Molkentin
bd74dbbfc5 doc: markup fixes 2013-05-17 12:02:40 +02:00
Daniel Molkentin
a0599e75b7 Update build instructions for Mac OS 2013-05-17 11:42:19 +02:00
Klaas Freitag
b33b638d2d A bit more verbose troubleshooting documentation. 2013-04-30 13:53:33 +02:00
Mario Enrico Ragucci
75448c41d4 Verified format cleanup (really...)
Signed-off-by: Mario Enrico Ragucci <github@ragucci.de>
2013-04-26 17:02:55 +02:00
Mario Enrico Ragucci
afc96e2021 Format cleanup
Signed-off-by: Mario Enrico Ragucci <github@ragucci.de>
2013-04-26 15:47:49 +02:00
Mario Enrico Ragucci
7e07d20d31 Remove LOG4C information as this is not needed anymore
Signed-off-by: Mario Enrico Ragucci <github@ragucci.de>
2013-04-26 13:32:35 +02:00
Mario Enrico Ragucci
1b5ed68375 Formatting cleanup 2013-04-26 01:00:50 +02:00
Mario Enrico Ragucci
ce996b3fc8 - Update Cross-Compiling section: Listing of all needed libraries to successfully build the Windows installer package
- Adding a note about the missing cross-compiled LOG4C package
- Minor changes to the documentation to be more specific about building the Windows package
2013-04-26 00:45:19 +02:00
hefee
25a3ceb94d adding WITH_DOC parameter to cmake
Fixes #412
2013-03-11 16:18:20 +01:00
Klaas Freitag
d3f51c611f Some more troubleshooting details. 2013-03-06 08:51:04 +01:00
Daniel Molkentin
e2e14f2184 Do not install docs on OS X 2013-02-21 15:26:31 +01:00
Klaas Freitag
58a5405343 Dont do the doc build step on every build. 2013-02-21 14:01:16 +01:00
Daniel Molkentin
7ba8a55fa5 Merge pull request #313 from hefee/doc2default
creating doc to default target
2013-02-12 11:48:00 -08:00
hefee
17901e7bc7 fixing typo in mirall.1.rst 2013-02-09 12:28:43 +01:00
hefee
0ea16c04cc moving description of config file and client optinos to own files.
* split usage to three files: usage, conffile, options
* fixing minor typos in mirall.1.rst and owncloud1.rst
* owncloud.1 uses include conffile, options
* mirall.1 uses include conffile, options
* Fixes: #183
2013-02-09 12:23:32 +01:00
hefee
e1f404a011 adding maclocation 2013-02-09 10:30:56 +01:00
hefee
69715d2182 merging from owncloud/master 2013-02-09 10:16:38 +01:00
hefee
0285213140 removing asciidoc, now creating manpages via sphinx again 2013-02-09 10:10:23 +01:00
hefee
1a907f23f0 moving generation of manpages to sphinx
--HG--
rename : doc/mirall.1.txt => doc/mirall.1.rst
rename : doc/owncloud.1.txt => doc/owncloud.1.rst
2013-02-09 10:05:45 +01:00
hefee
0ebcdbbb3f no more different cmake parameter is needed 2013-02-08 18:57:25 +01:00
LukeOwncloud
a617a04295 Update doc/usage.rst 2013-02-07 08:50:49 +01:00
hefee
1f4ea2c60e only add instalation dir if we are creating doc 2013-02-04 18:31:48 +01:00
hefee
edb4ff6b98 adding doc to default if CREATEDOC is set 2013-02-04 18:10:51 +01:00
Sandro Knauß
279bb47ab4 add creating manpages to CMakeLists 2013-02-04 17:36:56 +01:00
Sandro Knauß
7ef92748ea adding manpages for mirall and owncloud 2013-02-04 16:56:39 +01:00
Sandro Knauß
0e6e614318 adding --monoicons option to usage.rst 2013-02-04 16:55:50 +01:00
Klaas Freitag
4ea4c70443 Minor: Fixed a typo. 2013-01-23 10:57:45 +01:00
Klaas Freitag
1385aab65d Changed FindCSync module to not check relative pathes + docu. 2013-01-22 15:08:56 +01:00
Daniel Molkentin
5e3f2cf25a Remove legacy configuration options.
They were not used anyway.
2013-01-16 18:03:40 +01:00
Daniel Molkentin
5c495265f4 Consolidate theming support.
This implements out-of-repository-theming, and removes the old
custom.ini theming that never worked on all platforms and had
no straight deployment story.

The new approach requires the CMAKE variable OEM_THEME_DIR to
point to a directory that must at least contain an OEM.cmake file
(check OWNCLOUD.cmake for possible options) as well as a themes.qrc
and a themes/ directory that directly correspond to the ones in
the source tree.
2013-01-10 17:16:59 +01:00
Daniel Molkentin
08ab13dc4b Doc: More missing packages 2012-12-14 21:11:19 +01:00
Daniel Molkentin
aac9b770fc Details on windows builds 2012-12-14 20:42:59 +01:00
Daniel Molkentin
53aea61184 doc: Fix PDF generation here, too 2012-11-29 12:25:32 +01:00
Klaas Freitag
bf2181f111 Minor doc fix. 2012-11-27 15:46:17 +01:00
Daniel Molkentin
271d4fa22e Show last updated timestamp 2012-11-25 02:07:12 +01:00
Daniel Molkentin
a3a0202752 Fix copy/paste error 2012-11-25 01:20:25 +01:00
Daniel Molkentin
0da93f3eb5 Remove doc from the default target
The doc target requires strict parallel execution. Make it
a separate target unless we figure out how to do this with cmake.
2012-11-25 01:00:21 +01:00
Daniel Molkentin
78c7dc95a0 Add doc cmake targets (HTML, PDF, QtHelp, CHM, man)
make doc will build all of the above, except for CHM,
which needs manual preparation and can be built with
make doc-chm. See doc/scripts/README.rst for details.

We do our best to ensure to detect the required tools
before adding targets, so a build should always succeed.

Exception: On Debian and Ubuntu, the following packages are
required to build the PDF target (in addition to pdflatex
itself, which is autodetected):

* texlive-latex-recommended
* texlive-latex-extra
* texlive-fonts-recommended

If pdflatex is present, but those are not, the doc target
will fail.

Results can be found in $BUILDDIR/doc/$format.
2012-11-25 00:38:47 +01:00
Daniel Molkentin
f607cf55c6 doc: Make fit for use with make latexpdf 2012-11-24 02:35:18 +01:00
Daniel Molkentin
da64639f39 Update doc/building.rst
move packages into correct section
2012-11-21 15:20:15 +01:00
Daniel Molkentin
faa0f06fe3 Improve building section based on user feedback 2012-11-21 14:57:40 +01:00
Daniel Molkentin
9b8b656720 doc: Add Qt dependency to build instructions 2012-11-19 18:49:10 +01:00
Daniel Molkentin
8c9f8bdb6d doc: Fix build instructions; hint make package 2012-11-19 18:15:25 +01:00
Daniel Molkentin
ba9a07c2f2 Upate build docs 2012-11-15 14:42:10 +01:00
Daniel Molkentin
df219dd09b Doc: use correct cmake vars 2012-11-05 14:44:10 +01:00
Daniel Molkentin
80ecd71fc7 Doc: more trouble shooting 2012-11-05 11:36:48 +01:00
Daniel Molkentin
7d6eb61f1b doc: wording 2012-11-04 00:46:02 +01:00
Daniel Molkentin
3a165ad654 Doc: add troubleshooting section 2012-11-02 16:26:56 +01:00
Daniel Molkentin
06e7864174 Doc: Require sphinx todo extension 2012-11-01 19:10:51 +01:00
Daniel Molkentin
8b60726a48 Doc: Introduce chapter on Architecture, Glossary 2012-11-01 19:10:01 +01:00
Daniel Molkentin
855597bfd9 Doc: formatting 2012-11-01 17:24:25 +01:00
Daniel Molkentin
827a31fa02 doc: formatting fix 2012-11-01 17:03:58 +01:00
Daniel Molkentin
20f04ec6d9 doc: small improvements 2012-11-01 16:52:07 +01:00
Daniel Molkentin
83180310af doc: add chapter on (soft-)branding 2012-11-01 16:33:27 +01:00
Daniel Molkentin
9feb9b5262 Doc: fix typo 2012-10-31 17:22:03 +01:00
Daniel Molkentin
f2cfabcdb8 Doc: improve build instructions 2012-10-31 15:19:00 +01:00
Daniel Molkentin
6b2be97c22 Docs: add build chapter 2012-10-31 14:44:59 +01:00
Daniel Molkentin
6b0abed4ee Remove file checked-in by accident 2012-10-27 19:30:37 +02:00
Daniel Molkentin
bf8b9246fe Add docs 2012-10-27 17:05:01 +02:00