diff --git a/CMakeLists.txt b/CMakeLists.txt index f60d3acce..6aa56b942 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -323,4 +323,6 @@ if (NOT SHADOW) endif(ANDROID) endif() +add_subdirectory(docs) + include(cmake/installer.cmake) diff --git a/cmake/basic_definitions.cmake b/cmake/basic_definitions.cmake index 7362e70ca..b372f76df 100644 --- a/cmake/basic_definitions.cmake +++ b/cmake/basic_definitions.cmake @@ -8,7 +8,7 @@ set(PLATFORM_LIB ${LIB}-platform) set(ANDROID_LIB ${LIB}android) set(ABYSS libabyss) set(ABYSS_LIB abyss) -set(ABYSS_EXE ${ABYSS_LIB}-main) +set(DOCS_SRC "") get_filename_component(TT_ROOT "${CMAKE_CURRENT_LIST_DIR}/../vendor/libtuntap-master" ABSOLUTE) add_definitions(-D${CMAKE_SYSTEM_NAME}) diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt new file mode 100644 index 000000000..a9701cbf4 --- /dev/null +++ b/docs/CMakeLists.txt @@ -0,0 +1,38 @@ +find_program(DOXYGEN doxygen) +if (NOT DOXYGEN) + message(STATUS "Documentation generation disabled (doxygen not found)") + return() +endif() +find_program(SPHINX_BUILD sphinx-build) +if (NOT DOXYGEN) + message(STATUS "Documentation generation disabled (sphinx-build not found)") + return() + endif() + +set(lokinet_doc_sources "${DOCS_SRC}") +string(REPLACE ";" " " lokinet_doc_sources_spaced "${lokinet_doc_sources}") + +add_custom_command( + OUTPUT doxyxml/index.xml + COMMAND ${DOXYGEN} Doxyfile + DEPENDS + ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile + ${lokinet_doc_sources} +) + +add_custom_command( + OUTPUT html/index.html + COMMAND ${SPHINX_BUILD} + -Dbreathe_projects.lokinet=${CMAKE_CURRENT_BINARY_DIR}/doxyxml + -Dversion=${LLARP_VERSION} -Drelease=${LOKIMQ_VERSION} + -Aversion=${LLARP_VERSION} -Aversions=${LLARP_VERSION_MAJOR},${LLARP_VERSION_MINOR},${LLARP_VERSION_PATCH} + -b html + ${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_BINARY_DIR}/html + DEPENDS + ${CMAKE_CURRENT_SOURCE_DIR}/index.rst + ${CMAKE_CURRENT_SOURCE_DIR}/conf.py + ${CMAKE_CURRENT_BINARY_DIR}/doxyxml/index.xml +) +add_custom_target(doc DEPENDS html/index.html) +configure_file(Doxyfile.in Doxyfile @ONLY) + diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in new file mode 100644 index 000000000..dff5c36ed --- /dev/null +++ b/docs/Doxyfile.in @@ -0,0 +1,20 @@ +PROJECT_NAME = "Lokinet" +PROJECT_NUMBER = v@LLARP_VERSION@ +PROJECT_BRIEF = "Anonymous, decentralized and IP based overlay network for the internet." +OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@ +STRIP_FROM_PATH = @PROJECT_SOURCE_DIR@ @PROJECT_BINARY_DIR@ +JAVADOC_AUTOBRIEF = YES +ALIASES = "rst=\verbatim embed:rst" +ALIASES += "endrst=\endverbatim" +BUILTIN_STL_SUPPORT = YES +INPUT = @lokinet_doc_sources_spaced@ +INCLUDE_PATH = @PROJECT_SOURCE_DIR@/include @PROJECT_SOURCE_DIR@/llarp @PROJECT_SOURCE_DIR@/crypto/libntrup/include @PROJECT_SOURCE_DIR@/external/ghc-filesystem/include/ +RECURSIVE = YES +CLANG_ASSISTED_PARSING = YES +CLANG_OPTIONS = -std=c++17 -Wno-pragma-once-outside-header +GENERATE_HTML = NO +HTML_OUTPUT = doxyhtml +GENERATE_LATEX = NO +GENERATE_XML = YES +XML_OUTPUT = doxyxml +MACRO_EXPANSION = YES \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 000000000..6928bfd00 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,177 @@ +# -*- coding: utf-8 -*- +# +# Configuration file for the Sphinx documentation builder. +# +# This file does only contain a selection of the most common options. For a +# full list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = 'lokinet' +copyright = '2020, Jeff Becker' +author = 'Jeff Becker' + +# The short X.Y version +version = '' +# The full version, including alpha/beta/rc tags +release = '' + + + +# -- General configuration --------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. + +extensions = ['breathe'] +breathe_projects = { "lokinet": "@CMAKE_CURRENT_BINARY_DIR@/doxyxml/" } +breathe_default_project = "lokinet" +breathe_domain_by_extension = {"h" : "cpp", "hpp": "cpp"} + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +source_suffix = ['.rst', '.md'] + +# The master toctree document. +master_doc = 'index' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' +highlight_language = 'c++' +primary_domain = 'cpp' +default_role = 'cpp:any' +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# 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'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# The default sidebars (for documents that don't match any pattern) are +# defined by theme itself. Builtin themes are using these templates by +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', +# 'searchbox.html']``. +# +# html_sidebars = {} + + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = 'lokinetdoc' + + +# -- Options for LaTeX output ------------------------------------------------ + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'lokinet.tex', 'lokinet Documentation', + 'Jeff Becker', 'manual'), +] + + +# -- Options for manual page output ------------------------------------------ + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'lokinet', 'lokinet 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, 'lokinet', 'lokinet Documentation', + author, 'lokinet', 'One line description of project.', + 'Miscellaneous'), +] + + +# -- Options for Epub output ------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = project + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +# +# epub_identifier = '' + +# A unique identification for the text. +# +# epub_uid = '' + +# A list of files that should not be packed into the epub file. +epub_exclude_files = ['search.html'] diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 000000000..638766362 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,21 @@ + +Welcome to Lokinet's documentation! +=================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + +API +=== + +.. doxygenindex:: + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/llarp/CMakeLists.txt b/llarp/CMakeLists.txt index 768f27783..62b30c57b 100644 --- a/llarp/CMakeLists.txt +++ b/llarp/CMakeLists.txt @@ -5,7 +5,6 @@ set(LIB_UTIL_SRC config/ini.cpp config/key_manager.cpp constants/limits.cpp - ${CMAKE_CURRENT_BINARY_DIR}/constants/version.cpp util/bencode.cpp util/buffer.cpp util/encode.cpp @@ -32,7 +31,7 @@ set(LIB_UTIL_SRC util/time.cpp ) -add_library(${UTIL_LIB} STATIC ${LIB_UTIL_SRC}) +add_library(${UTIL_LIB} STATIC ${LIB_UTIL_SRC} ${CMAKE_CURRENT_BINARY_DIR}/constants/version.cpp) add_dependencies(${UTIL_LIB} genversion) @@ -243,3 +242,7 @@ endif() add_log_tag(${UTIL_LIB}) add_log_tag(${PLATFORM_LIB}) add_log_tag(${STATIC_LIB}) + +file(GLOB_RECURSE docs_SRC */*.hpp) + +set(DOCS_SRC ${docs_SRC} PARENT_SCOPE)