diff --git a/build.gradle b/build.gradle index f0690b4..23d227a 100644 --- a/build.gradle +++ b/build.gradle @@ -1,4 +1,7 @@ -apply plugin: 'java' +plugins { + id 'java' + id 'kr.motd.sphinx' version '2.9.0' +} project.group = projectGroup project.version = projectVersion @@ -42,3 +45,8 @@ dependencies { test { useJUnitPlatform() } + +sphinx { + sourceDirectory = "${projectDir}/src/docs" + outputDirectory = "${project.buildDir}/site/docs" +} \ No newline at end of file diff --git a/src/docs/conf.py b/src/docs/conf.py new file mode 100644 index 0000000..a511937 --- /dev/null +++ b/src/docs/conf.py @@ -0,0 +1,34 @@ +# -*- coding: utf-8 -*- +import sys, os +from recommonmark.parser import CommonMarkParser + +project = u'My Project' +copyright = u'YYYY, John Doe' +version = '1.0' +release = '1.0.0' + +# General options +needs_sphinx = '1.0' +master_doc = 'index' +pygments_style = 'tango' +add_function_parentheses = True + +extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.plantuml'] +templates_path = ['_templates'] +exclude_trees = ['.build'] +source_suffix = ['.rst', '.md'] +source_encoding = 'utf-8-sig' +source_parsers = { + '.md': CommonMarkParser +} + +# HTML options +html_theme = 'sphinx_rtd_theme' +html_short_title = "my-project" +htmlhelp_basename = 'my-project-doc' +html_use_index = True +html_show_sourcelink = False +html_static_path = ['_static'] + +# PlantUML options +plantuml = os.getenv('plantuml') diff --git a/src/docs/index.rst b/src/docs/index.rst new file mode 100644 index 0000000..37229ba --- /dev/null +++ b/src/docs/index.rst @@ -0,0 +1,27 @@ +Это заголовок +============= +Заголовок содержит главную тему и отделяется символами '='. +Их количество должно быть не меньше, чем количество символов +в заголовке. + +Подзаголовок +------------ +Подзаголовки отделяются символами '-'. Их количество должно +быть тем же, что и количество символов в подзаголовке +(так же, как и в случае с заголовками). + +Списки могут быть маркированными: + + * Элемент Foo + * Элемент Bar + +Или же автоматически пронумерованными: + + #. Элемент 1 + #. Элемент 2 + +Внутренняя разметка +------------––––––- +Слова можно выделять *наклонным* или **полужирным** шрифтами. +Фрагменты кода (например, примеры команд) можно заключать в обратные кавычки, например: +команда ``sudo`` дает вам привилегии суперпользователя!