diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..3b4764d --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,17 @@ +# .readthedocs.yml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Build documentation in the documentation/ directory with Sphinx +sphinx: + configuration: documentation/conf.py + +# Build documentation with MkDocs +#mkdocs: +# configuration: mkdocs.yml + +# Optionally build your docs in additional formats such as PDF and ePub +formats: all diff --git a/Doxyfile b/Doxyfile index 2858b5b..cacec46 100644 --- a/Doxyfile +++ b/Doxyfile @@ -38,7 +38,7 @@ PROJECT_NAME = pvaClientCPP # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = +PROJECT_NUMBER = 4.7.0-dev # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a @@ -152,7 +152,7 @@ FULL_PATH_NAMES = YES # will be relative from the directory where doxygen is started. # This tag requires that the tag FULL_PATH_NAMES is set to YES. -STRIP_FROM_PATH = +STRIP_FROM_PATH = src # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the # path mentioned in the documentation of a class, which tells the reader which @@ -161,7 +161,7 @@ STRIP_FROM_PATH = # specify the list of include paths that are normally passed to the compiler # using the -I flag. -STRIP_FROM_INC_PATH = +STRIP_FROM_INC_PATH = src # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but # less readable) file names. This can be useful is your file systems doesn't @@ -765,7 +765,8 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = include +INPUT = src \ + src/pv # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -796,7 +797,7 @@ FILE_PATTERNS = # be searched for input files as well. # The default value is: NO. -RECURSIVE = YES +RECURSIVE = NO # The EXCLUDE tag can be used to specify files and/or directories that should be # excluded from the INPUT source files. This way you can easily exclude a @@ -1035,7 +1036,7 @@ GENERATE_HTML = YES # The default directory is: html. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_OUTPUT = documentation/html +HTML_OUTPUT = html/doxygen # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each # generated HTML page (for example: .htm, .php, .asp). diff --git a/documentation/_static/css/custom.css b/documentation/_static/css/custom.css new file mode 100644 index 0000000..fcecd47 --- /dev/null +++ b/documentation/_static/css/custom.css @@ -0,0 +1,7 @@ +.wy-side-nav-search { + background-color: #18334B; +} + +.wy-side-nav-search input[type="text"] { + border-color: #18334b; +} \ No newline at end of file diff --git a/documentation/conf.py b/documentation/conf.py new file mode 100644 index 0000000..1f1b756 --- /dev/null +++ b/documentation/conf.py @@ -0,0 +1,80 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains 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 = 'normativeTypes (C++)' +copyright = '2019, EPICS Controls.' +author = 'EPICS' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.intersphinx', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# 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 = ['_build', 'Thumbs.db', '.DS_Store'] + +# Intersphinx links to subprojects +intersphinx_mapping = { +} + + +# -- 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 = '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_css_files = [ + 'css/custom.css', +] + +master_doc = 'index' + +html_theme_options = { + 'logo_only': True, +} +html_logo = "images/EPICS_white_logo_v02.png" + +html_extra_path = [ + '../html', + 'pvaClientCPP.html', +] + + +# -- Run Doxygen ------------------------------------------------------------ + +import subprocess +subprocess.call('cd ..; mkdir -p html/doxygen; doxygen', shell=True) diff --git a/documentation/images/EPICS_white_logo_v02.png b/documentation/images/EPICS_white_logo_v02.png new file mode 100644 index 0000000..01178ef Binary files /dev/null and b/documentation/images/EPICS_white_logo_v02.png differ diff --git a/documentation/index.rst b/documentation/index.rst new file mode 100644 index 0000000..12f9cf3 --- /dev/null +++ b/documentation/index.rst @@ -0,0 +1,17 @@ +pvaClient (C++) Library +======================== + +.. toctree:: + :hidden: + + EPICS Website + EPICS Documentation Home + + +.. toctree:: + :maxdepth: 1 + :caption: pvaClientCPP + + Reference Manual + API Documentation + Source Code Repository on GitHub