From efbc002b78f9052cf299a57010e091140118b15c Mon Sep 17 00:00:00 2001 From: Faruk D Date: Tue, 2 Oct 2018 12:22:04 +0200 Subject: [PATCH 1/2] integrate codedocs and add badge --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 4b3c5bb..839b06d 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ | ------------- | ------------- | | [![Build Status](https://travis-ci.org/nlesc-dirac/sagecal.svg?branch=master)](https://travis-ci.org/nlesc-dirac/sagecal) | [![Build Status](https://travis-ci.org/nlesc-dirac/sagecal.svg?branch=dev)](https://travis-ci.org/nlesc-dirac/sagecal) | +[![Documentation](https://codedocs.xyz/nlesc-dirac/sagecal.svg)](https://codedocs.xyz/nlesc-dirac/sagecal/) # SAGECAL @@ -24,6 +25,9 @@ Read INSTALL for installation. This file gives a brief guide to use SAGECal. Warning: this file may be obsolete. use sagecal -h to see up-to-date options. +## Code documentation +Code documentation can be found [here](https://codedocs.xyz/nlesc-dirac/sagecal). + ## Step by Step Introduction: From ca117eb000872f3a1a74ffa20930827d251fab1b Mon Sep 17 00:00:00 2001 From: Faruk D Date: Tue, 2 Oct 2018 12:29:27 +0200 Subject: [PATCH 2/2] add codedocs configuration --- .codedocs | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 .codedocs diff --git a/.codedocs b/.codedocs new file mode 100644 index 0000000..a612d93 --- /dev/null +++ b/.codedocs @@ -0,0 +1,47 @@ +# CodeDocs.xyz Configuration File + +# Optional project name, if left empty the GitHub repository name will be used. +PROJECT_NAME = "SageCal" + +# One or more directories and files that contain example code to be included. +#EXAMPLE_PATH = + +# One or more directories and files to exclude from documentation generation. +# Use relative paths with respect to the repository root directory. +EXCLUDE = pkg build + +# One or more wildcard patterns to exclude files and directories from document +# generation. +#EXCLUDE_PATTERNS = + +# One or more symbols to exclude from document generation. Symbols can be +# namespaces, classes, or functions. +#EXCLUDE_SYMBOLS = + +# Override the default parser (language) used for each file extension. +EXTENSION_MAPPING = + +# Set the wildcard patterns used to filter out the source-files. +# If left blank the default is: +# *.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, +# *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, +# *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox, *.py, +# *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. +FILE_PATTERNS = *.c \ + *.cpp \ + *.cxx \ + *.cu \ + *.h \ + *.hpp \ + *.md + +# Hide undocumented class members. +#HIDE_UNDOC_MEMBERS = + +# Hide undocumented classes. +#HIDE_UNDOC_CLASSES = + +# Specify a markdown page whose contents should be used as the main page +# (index.html). This will override a page marked as \mainpage. For example, a +# README.md file usually serves as a useful main page. +USE_MDFILE_AS_MAINPAGE = README.md