tobias/docker-offlineimap
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

improve documentation

Browse Source 
- README
- restrict sphinx documentation to the API
- update the Makefiles

Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
This commit is contained in:
Nicolas Sebrecht 2015-03-13 19:10:48 +01:00
parent 09fca0ccb1
commit 5eeea9ed83
4 changed files with 14 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Makefile
View File

@ -39,10 +39,7 @@ clean:
-find . -name auth -exec rm -vf {}/password {}/username \; -find . -name auth -exec rm -vf {}/password {}/username \;
@$(MAKE) -C clean @$(MAKE) -C clean
man: docs:
@$(MAKE) -C man
doc:
@$(MAKE) -C docs @$(MAKE) -C docs
targz: ../$(TARGZ) targz: ../$(TARGZ)

20
README.md
View File

@ -63,14 +63,16 @@ Bugs, issues and contributions can be requested to both the mailing list or the
## Documentation ## Documentation
The documentation is included (in .rst format) in the `docs` directory. All the current and updated documentation is at the [community's website][website].
Read it directly or generate nice html docs (python-sphinx needed) and/or
the man page (python-docutils needed) while being in the `docs` dir via:
'make doc' (user docs), 'make man' (man page only) or 'make' (both) ### Dispose locally
(`make html` will simply create html versions of all *.rst files in /docs) You might want to dispose the documentation locally. Get the sources of the website.
For the other documentations, run the approppriate make target:
The resulting user documentation will be in `docs/html`. The full user ```
docs are also at: http://docs.offlineimap.org. Please see there for $ ./scripts/get-repository.sh website
detailed information on how to install and configure OfflineImap. $ cd docs
$ make html # Require rst2html
$ make man # Require a2x
$ make api # Require sphinx
```

4
docs/Makefile
View File

@ -9,7 +9,7 @@ RST2HTML=`type rst2html >/dev/null 2>&1 && echo rst2html || echo rst2html.py`
RST2MAN=`type rst2man >/dev/null 2>&1 && echo rst2man || echo rst2man.py` RST2MAN=`type rst2man >/dev/null 2>&1 && echo rst2man || echo rst2man.py`
SPHINXBUILD = sphinx-build SPHINXBUILD = sphinx-build
all: man doc docs: man api
html: $(HTML_TARGETS) html: $(HTML_TARGETS)
@ -24,7 +24,7 @@ offlineimap.1: offlineimap.txt
offlineimapui.7: offlineimapui.txt offlineimapui.7: offlineimapui.txt
a2x -v -f manpage $? a2x -v -f manpage $?
doc: api:
$(SPHINXBUILD) -b html -d html/doctrees doc-src html $(SPHINXBUILD) -b html -d html/doctrees doc-src html
websitedoc: websitedoc:

3
docs/doc-src/index.rst
View File

@ -5,9 +5,6 @@
Welcome to OfflineIMAP's developer documentation Welcome to OfflineIMAP's developer documentation
================================================ ================================================
**Developer documentation**
* :doc:`Advanced Git <GitAdvanced>`
**Documented APIs** **Documented APIs**
.. toctree:: .. toctree::