Repository: james-project Updated Branches: refs/heads/master 538ed5382 -> b1d500a9a
JAMES-1671 generate pretty documentation with mkdocs Project: http://git-wip-us.apache.org/repos/asf/james-project/repo Commit: http://git-wip-us.apache.org/repos/asf/james-project/commit/b1d500a9 Tree: http://git-wip-us.apache.org/repos/asf/james-project/tree/b1d500a9 Diff: http://git-wip-us.apache.org/repos/asf/james-project/diff/b1d500a9 Branch: refs/heads/master Commit: b1d500a9addc0928323ddc4eb8decda6bf111111 Parents: 538ed53 Author: Matthieu Baechler <[email protected]> Authored: Tue Feb 2 17:28:20 2016 +0100 Committer: Matthieu Baechler <[email protected]> Committed: Fri Feb 12 10:52:57 2016 +0100 ---------------------------------------------------------------------- server/protocols/jmap/doc/Dockerfile | 19 +++++++++++++++++++ server/protocols/jmap/doc/README.md | 15 +++++++++++++++ server/protocols/jmap/doc/annotation.css | 16 ++++++++++++++++ server/protocols/jmap/doc/mkdocs.yml | 6 ++++++ 4 files changed, 56 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/james-project/blob/b1d500a9/server/protocols/jmap/doc/Dockerfile ---------------------------------------------------------------------- diff --git a/server/protocols/jmap/doc/Dockerfile b/server/protocols/jmap/doc/Dockerfile new file mode 100644 index 0000000..cd71a80 --- /dev/null +++ b/server/protocols/jmap/doc/Dockerfile @@ -0,0 +1,19 @@ +FROM iron/python:2-dev + +RUN pip install mkdocs + +COPY . /doc + +RUN find . -name "*.mdwn" | while IFS= read -r f; do mv -v "$f" "$(echo "$f" | sed -e 's/.mdwn$/.md/' - )"; done + +RUN mv /doc/specs/spec/apimodel.md /doc/specs/index.md + +WORKDIR /doc + +RUN mkdocs build --clean + +WORKDIR site + +EXPOSE 8000 + +CMD python -m SimpleHTTPServer 8000 \ No newline at end of file http://git-wip-us.apache.org/repos/asf/james-project/blob/b1d500a9/server/protocols/jmap/doc/README.md ---------------------------------------------------------------------- diff --git a/server/protocols/jmap/doc/README.md b/server/protocols/jmap/doc/README.md new file mode 100644 index 0000000..99c78b2 --- /dev/null +++ b/server/protocols/jmap/doc/README.md @@ -0,0 +1,15 @@ +Annotated JMAP documentation +============================ + +This directory contains annotated jmap documentation as found on http://jmap.io/. + +Annotations aim at tracking implementation progress in James project. + +You can read it as an html site using the provided Dockerfile. + +Ì +$ docker build --tag=mkdocs . +$ docker run --rm -p 8000:8000 mkdocs +Ì + +Then open http://localhost:8000/ in your browser. http://git-wip-us.apache.org/repos/asf/james-project/blob/b1d500a9/server/protocols/jmap/doc/annotation.css ---------------------------------------------------------------------- diff --git a/server/protocols/jmap/doc/annotation.css b/server/protocols/jmap/doc/annotation.css new file mode 100644 index 0000000..70134dd --- /dev/null +++ b/server/protocols/jmap/doc/annotation.css @@ -0,0 +1,16 @@ +aside { + padding: 1em; + margin-top: 1.5em; + margin-bottom: 1.5em; + background: #6F8000; + line-height: 1.6; + font-family: 'FontAwesome'; +} +aside:before { + padding-right: 0.5em; + font-size: 14px; +} +aside.warning { background: #ac5c64; } +aside.warning:before { content: "\f071"; } +aside.notice { background: #67875C; } +aside.notice:before { content: "\f06a"; } http://git-wip-us.apache.org/repos/asf/james-project/blob/b1d500a9/server/protocols/jmap/doc/mkdocs.yml ---------------------------------------------------------------------- diff --git a/server/protocols/jmap/doc/mkdocs.yml b/server/protocols/jmap/doc/mkdocs.yml new file mode 100644 index 0000000..0e5c77f --- /dev/null +++ b/server/protocols/jmap/doc/mkdocs.yml @@ -0,0 +1,6 @@ +docs_dir: specs +site_name: JMAP specifications with annotations from apache/james contributors +theme: readthedocs +use_directory_urls: false +extra_css: + - annotations.css --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
