9 Commits
6.0.0 ... 6.0.1

Author SHA1 Message Date
Andrew Johnson
1250a3c236 Reset development flag for 6.0.1 release 2019-10-31 16:30:33 -05:00
Andrew Johnson
28e5defc9b Document read-the-docs in Release Notes for 6.0.1 2019-10-31 16:29:32 -05:00
Ralph Lange
fbe1a1135f doc: fix link to reference manual 2019-09-06 10:42:53 +02:00
Ralph Lange
b75f942d5a doc: update/improve ntCPP.rst
- update Sourceforge links
- rename V4 -> 7
- shorten section names
2019-09-06 10:42:53 +02:00
Ralph Lange
e83ce61bf6 rtd-ci: add read-the-docs integration 2019-09-06 10:42:53 +02:00
Ralph Lange
86d8b5deec doc: change doxygen HTML_OUTPUT to html/doxygen 2019-09-05 14:52:59 +02:00
Ralph Lange
abbcf486b8 doc: make doxygen search src (not include) 2019-09-05 13:05:18 +02:00
Ralph Lange
e286d32716 doc: convert ntCPP.html to ntCPP.rst 2019-09-05 11:51:17 +02:00
Andrew Johnson
ba33c7443c Update version number to 6.0.1 DEVELOPMENT 2019-08-13 11:09:49 -05:00
11 changed files with 3405 additions and 2993 deletions

17
.readthedocs.yml Normal file
View File

@@ -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

View File

@@ -743,7 +743,7 @@ WARN_LOGFILE =
# spaces.
# Note: If this tag is empty the current directory is searched.
INPUT = include
INPUT = src
# 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
@@ -1008,7 +1008,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).

View File

@@ -1,3 +1,12 @@
# Version number for the Normative Types API and shared library
EPICS_NTYPES_MAJOR_VERSION = 6
EPICS_NTYPES_MINOR_VERSION = 0
EPICS_NTYPES_MAINTENANCE_VERSION = 0
EPICS_NTYPES_MAINTENANCE_VERSION = 1
# Development flag, set to zero for release versions
EPICS_NTYPES_DEVELOPMENT_FLAG = 0
# Immediately after a release the MAINTENANCE_VERSION
# will be incremented and the DEVELOPMENT_FLAG set to 1

View File

@@ -2,6 +2,10 @@
This document summarizes the changes to the module between releases.
## Release 6.0.1 (EPICS 7.0.3.1, October 2019)
* Doxygen updates and read-the-docs integration.
## Release 6.0.0 (EPICS 7.0.3, July 2019)
* Reimplement `isCompatible` methods to use a new internal validation API in order to make the implementation uniform, less repetitive and less strict.

View File

@@ -0,0 +1,7 @@
.wy-side-nav-search {
background-color: #18334B;
}
.wy-side-nav-search input[type="text"] {
border-color: #18334b;
}

77
documentation/conf.py Normal file
View File

@@ -0,0 +1,77 @@
# 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']
# -- Run Doxygen ------------------------------------------------------------
import subprocess
subprocess.call('cd ..; mkdir -p html/doxygen; doxygen', shell=True)

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.5 KiB

17
documentation/index.rst Normal file
View File

@@ -0,0 +1,17 @@
NormativeTypes (C++) Library
============================
.. toctree::
:hidden:
EPICS Website <https://epics-controls.org>
EPICS Documentation Home <https://docs.epics-controls.org>
.. toctree::
:maxdepth: 1
:caption: normativeTypesCPP
Reference Manual <ntCPP>
API Documentation <https://docs.epics-controls.org/projects/normativetypes-cpp/en/latest/doxygen>
Source Code Repository on GitHub <https://github.com/epics-base/normativeTypesCPP>

File diff suppressed because it is too large Load Diff

3270
documentation/ntCPP.rst Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -31,7 +31,7 @@
/** @page Overview Documentation
*
* <a href = "ntCPP.html">ntCPP.html</a>
* <a href = "../ntCPP.html">Normative Types (C++) Reference</a>
*
*/