diff options
| -rw-r--r-- | CMakeLists.txt | 9 | ||||
| -rw-r--r-- | doc/conf.py | 20 | ||||
| -rw-r--r-- | doc/contributing.rst | 2 | ||||
| -rw-r--r-- | doc/man_index.rst | 9 | ||||
| -rw-r--r-- | doc/synopsis.rst | 4 | ||||
| -rw-r--r-- | packaging/biboumi.spec.cmake | 2 |
6 files changed, 24 insertions, 22 deletions
diff --git a/CMakeLists.txt b/CMakeLists.txt index ebf63ab..5a8d99a 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -74,8 +74,11 @@ set(SOFTWARE_VERSION # ## The rule that generates the documentation # -add_custom_target(doc COMMAND make html BUILDDIR=${CMAKE_CURRENT_BINARY_DIR} +add_custom_target(html COMMAND make html BUILDDIR=${CMAKE_CURRENT_BINARY_DIR} WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/doc) +add_custom_target(man COMMAND make man BUILDDIR=${CMAKE_CURRENT_BINARY_DIR} + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/doc) +add_custom_target(doc DEPENDS html man) # ## Set this search path for cmake, to find our custom search modules @@ -309,7 +312,7 @@ endif() ## Add some custom rules to launch the tests # add_custom_target(check COMMAND "test_suite" - DEPENDS test_suite biboumi) + DEPENDS test_suite) set_target_properties(check PROPERTIES EXCLUDE_FROM_ALL TRUE) add_custom_target(e2e COMMAND "python3" "${CMAKE_CURRENT_SOURCE_DIR}/tests/end_to_end/" DEPENDS biboumi) @@ -343,7 +346,7 @@ add_custom_target(everything DEPENDS test_suite biboumi) ## Install target # install(TARGETS ${PROJECT_NAME} RUNTIME DESTINATION bin) -install(FILES ${MAN_PAGE} DESTINATION share/man/man1 OPTIONAL COMPONENT documentation) +install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/biboumi.1 DESTINATION share/man/man1 OPTIONAL COMPONENT documentation) install(FILES ${CMAKE_CURRENT_BINARY_DIR}/biboumi.service DESTINATION lib/systemd/system COMPONENT init) file(GLOB policy_files conf/*policy.txt) install(FILES ${policy_files} DESTINATION /etc/biboumi COMPONENT configuration) diff --git a/doc/conf.py b/doc/conf.py index e3f0e02..c607fc5 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -52,7 +52,6 @@ templates_path = ['_templates'] # source_suffix = ['.rst', '.md'] source_suffix = '.rst' -# The master toctree document. master_doc = 'index' # The language for content autogenerated by Sphinx. Refer to documentation @@ -87,7 +86,7 @@ html_theme = 'sphinx_rtd_theme' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +#html_static_path = ['_static'] # Custom sidebar templates, must be a dictionary that maps document names # to template names. @@ -131,7 +130,7 @@ latex_elements = { # author, documentclass [howto, manual, or own class]). latex_documents = [ (master_doc, 'biboumi.tex', 'biboumi Documentation', - 'Florent Le Coz', 'manual'), + author, 'manual'), ] @@ -140,21 +139,8 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'biboumi', 'biboumi Documentation', + ('man_index', 'biboumi', 'biboumi Documentation', [author], 1) ] - -# -- Options for Texinfo output ---------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - (master_doc, 'biboumi', 'biboumi Documentation', - author, 'biboumi', 'One line description of project.', - 'Miscellaneous'), -] - - # -- Extension configuration ------------------------------------------------- diff --git a/doc/contributing.rst b/doc/contributing.rst index ee499fc..26572fa 100644 --- a/doc/contributing.rst +++ b/doc/contributing.rst @@ -91,7 +91,7 @@ Please try to follow the existing style: - Use only spaces, not tabs. - Curly brackets are on their own lines. - Use this-> everywhere it’s possible. -- Don’t start class attributes with “m_” or similar. +- Don’t start class attributes with “m\_” or similar. - Type names are in PascalCase. - Everything else is in snake_case. diff --git a/doc/man_index.rst b/doc/man_index.rst new file mode 100644 index 0000000..3de981d --- /dev/null +++ b/doc/man_index.rst @@ -0,0 +1,9 @@ +Biboumi's man page index +======================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + synopsis + admin diff --git a/doc/synopsis.rst b/doc/synopsis.rst new file mode 100644 index 0000000..5b93a92 --- /dev/null +++ b/doc/synopsis.rst @@ -0,0 +1,4 @@ +Synopsis +======== + +biboumi [*config_filename*] diff --git a/packaging/biboumi.spec.cmake b/packaging/biboumi.spec.cmake index c1dbf0d..6f4676d 100644 --- a/packaging/biboumi.spec.cmake +++ b/packaging/biboumi.spec.cmake @@ -45,7 +45,7 @@ cmake . -DCMAKE_CXX_FLAGS="%{optflags}" \ -DWITH_POSTGRESQL=1 make %{?_smp_mflags} - +make man %install make install DESTDIR=%{buildroot} |