Skip to content

Commit

Permalink
Docs for doxygen website
Browse files Browse the repository at this point in the history
  • Loading branch information
S-Mazigh committed Oct 24, 2024
1 parent 1f0a11b commit 0aba0e6
Show file tree
Hide file tree
Showing 19 changed files with 6,875 additions and 20 deletions.
216 changes: 216 additions & 0 deletions .clang-format
Original file line number Diff line number Diff line change
@@ -0,0 +1,216 @@
---
Language: Cpp
# BasedOnStyle: Mozilla
AccessModifierOffset: -2
AlignAfterOpenBracket: Align
AlignArrayOfStructures: None
AlignConsecutiveAssignments:
Enabled: false
AcrossEmptyLines: false
AcrossComments: false
AlignCompound: false
PadOperators: true
AlignConsecutiveBitFields:
Enabled: false
AcrossEmptyLines: false
AcrossComments: false
AlignCompound: false
PadOperators: false
AlignConsecutiveDeclarations:
Enabled: false
AcrossEmptyLines: false
AcrossComments: false
AlignCompound: false
PadOperators: false
AlignConsecutiveMacros:
Enabled: false
AcrossEmptyLines: false
AcrossComments: false
AlignCompound: false
PadOperators: false
AlignEscapedNewlines: Right
AlignOperands: Align
AlignTrailingComments: true
AllowAllArgumentsOnNextLine: true
AllowAllParametersOfDeclarationOnNextLine: false
AllowShortEnumsOnASingleLine: true
AllowShortBlocksOnASingleLine: Never
AllowShortCaseLabelsOnASingleLine: false
AllowShortFunctionsOnASingleLine: Inline
AllowShortLambdasOnASingleLine: All
AllowShortIfStatementsOnASingleLine: Never
AllowShortLoopsOnASingleLine: false
AlwaysBreakAfterDefinitionReturnType: TopLevel
AlwaysBreakAfterReturnType: TopLevel
AlwaysBreakBeforeMultilineStrings: false
AlwaysBreakTemplateDeclarations: Yes
AttributeMacros:
- __capability
BinPackArguments: false
BinPackParameters: false
BraceWrapping:
AfterCaseLabel: false
AfterClass: true
AfterControlStatement: Never
AfterEnum: true
AfterFunction: true
AfterNamespace: false
AfterObjCDeclaration: false
AfterStruct: true
AfterUnion: true
AfterExternBlock: true
BeforeCatch: false
BeforeElse: false
BeforeLambdaBody: false
BeforeWhile: false
IndentBraces: false
SplitEmptyFunction: true
SplitEmptyRecord: false
SplitEmptyNamespace: true
BreakBeforeBinaryOperators: None
BreakBeforeConceptDeclarations: Always
BreakBeforeBraces: Mozilla
BreakBeforeInheritanceComma: false
BreakInheritanceList: BeforeComma
BreakBeforeTernaryOperators: true
BreakConstructorInitializersBeforeComma: false
BreakConstructorInitializers: BeforeComma
BreakAfterJavaFieldAnnotations: false
BreakStringLiterals: true
ColumnLimit: 120
CommentPragmas: '^ IWYU pragma:'
QualifierAlignment: Leave
CompactNamespaces: false
ConstructorInitializerIndentWidth: 4
ContinuationIndentWidth: 4
Cpp11BracedListStyle: false
DeriveLineEnding: true
DerivePointerAlignment: false
DisableFormat: false
EmptyLineAfterAccessModifier: Never
EmptyLineBeforeAccessModifier: LogicalBlock
ExperimentalAutoDetectBinPacking: false
PackConstructorInitializers: BinPack
BasedOnStyle: ''
ConstructorInitializerAllOnOneLineOrOnePerLine: false
AllowAllConstructorInitializersOnNextLine: true
FixNamespaceComments: false
ForEachMacros:
- foreach
- Q_FOREACH
- BOOST_FOREACH
IfMacros:
- KJ_IF_MAYBE
IncludeBlocks: Preserve
IncludeCategories:
- Regex: '^"(llvm|llvm-c|clang|clang-c)/'
Priority: 2
SortPriority: 0
CaseSensitive: false
- Regex: '^(<|"(gtest|gmock|isl|json)/)'
Priority: 3
SortPriority: 0
CaseSensitive: false
- Regex: '.*'
Priority: 1
SortPriority: 0
CaseSensitive: false
IncludeIsMainRegex: '(Test)?$'
IncludeIsMainSourceRegex: ''
IndentAccessModifiers: false
IndentCaseLabels: true
IndentCaseBlocks: false
IndentGotoLabels: true
IndentPPDirectives: None
IndentExternBlock: AfterExternBlock
IndentRequiresClause: true
IndentWidth: 4
IndentWrappedFunctionNames: false
InsertBraces: false
InsertTrailingCommas: None
JavaScriptQuotes: Leave
JavaScriptWrapImports: true
KeepEmptyLinesAtTheStartOfBlocks: true
LambdaBodyIndentation: Signature
MacroBlockBegin: ''
MacroBlockEnd: ''
MaxEmptyLinesToKeep: 1
NamespaceIndentation: None
ObjCBinPackProtocolList: Auto
ObjCBlockIndentWidth: 4
ObjCBreakBeforeNestedBlockParam: true
ObjCSpaceAfterProperty: true
ObjCSpaceBeforeProtocolList: false
PenaltyBreakAssignment: 2
PenaltyBreakBeforeFirstCallParameter: 19
PenaltyBreakComment: 300
PenaltyBreakFirstLessLess: 120
PenaltyBreakOpenParenthesis: 0
PenaltyBreakString: 1000
PenaltyBreakTemplateDeclaration: 10
PenaltyExcessCharacter: 1000000
PenaltyReturnTypeOnItsOwnLine: 200
PenaltyIndentedWhitespace: 0
PointerAlignment: Left
PPIndentWidth: -1
ReferenceAlignment: Pointer
ReflowComments: true
RemoveBracesLLVM: false
RequiresClausePosition: OwnLine
SeparateDefinitionBlocks: Leave
ShortNamespaceLines: 1
SortIncludes: CaseSensitive
SortJavaStaticImport: Before
SortUsingDeclarations: true
SpaceAfterCStyleCast: false
SpaceAfterLogicalNot: false
SpaceAfterTemplateKeyword: false
SpaceBeforeAssignmentOperators: true
SpaceBeforeCaseColon: false
SpaceBeforeCpp11BracedList: false
SpaceBeforeCtorInitializerColon: true
SpaceBeforeInheritanceColon: true
SpaceBeforeParens: ControlStatements
SpaceBeforeParensOptions:
AfterControlStatements: true
AfterForeachMacros: true
AfterFunctionDefinitionName: false
AfterFunctionDeclarationName: false
AfterIfMacros: true
AfterOverloadedOperator: false
AfterRequiresInClause: false
AfterRequiresInExpression: false
BeforeNonEmptyParentheses: false
SpaceAroundPointerQualifiers: Default
SpaceBeforeRangeBasedForLoopColon: true
SpaceInEmptyBlock: false
SpaceInEmptyParentheses: false
SpacesBeforeTrailingComments: 1
SpacesInAngles: Never
SpacesInConditionalStatement: false
SpacesInContainerLiterals: true
SpacesInCStyleCastParentheses: false
SpacesInLineCommentPrefix:
Minimum: 1
Maximum: -1
SpacesInParentheses: false
SpacesInSquareBrackets: false
SpaceBeforeSquareBrackets: false
BitFieldColonSpacing: Both
Standard: Latest
StatementAttributeLikeMacros:
- Q_EMIT
StatementMacros:
- Q_UNUSED
- QT_REQUIRE_VERSION
TabWidth: 4
UseCRLF: false
UseTab: true
WhitespaceSensitiveMacros:
- STRINGIZE
- PP_STRINGIZE
- BOOST_PP_STRINGIZE
- NS_SWIFT_NAME
- CF_SWIFT_NAME
...

26 changes: 26 additions & 0 deletions .github/workflows/doxygen-deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Publish Documentation
on:
release:
types: [published]
workflow_dispatch: # Allows manual triggers from GitHub UI

jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Generate Documentation
uses: mattnotmitt/doxygen-action@edge
with:
working-directory: './docs'
doxyfile-path: './doxygen-configFile'

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/build/html
force_orphan: true # keeps gh-pages branch clean
commit_message: "docs: update doxygen documentation"
58 changes: 38 additions & 20 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,8 @@ outputs
inputs
painless-mcomsps
painless
docs/
doxygen/html
doxygen/latex
doxygen/markdowns
.html
docs/build
html
.pdf
*.uri
get_sat22_inputs.sh
Expand All @@ -23,19 +20,21 @@ get_sat22_inputs.sh
*.h_old
*.ignore
*.o
hostfile
hostfile.*
openMPI
*.out
*.pb.*
*.local

libs/m4ri-20140914/Makefile
libs/m4ri-20140914/config.status
libs/m4ri-20140914/libm4ri.la
libs/m4ri-20140914/libtool
libs/m4ri-20140914/m4ri/m4ri_config.h
libs/m4ri-20140914/autom4te.cache
libs/m4ri-20140914/configure~
libs/m4ri-20140914/m4ri/config.h.in~
libs/m4ri-20200125/.libs
libs/m4ri-20200125/*/.*
libs/m4ri-20200125/Makefile
libs/m4ri-20200125/config.status
libs/m4ri-20200125/libm4ri.la
libs/m4ri-20200125/libtool
libs/m4ri-20200125/m4ri/m4ri_config.h
libs/m4ri-20200125/autom4te.cache
libs/m4ri-20200125/configure~
libs/m4ri-20200125/m4ri/config.h.in~
libs/m4ri-20200125/Makefile
libs/m4ri-20200125/Makefile.in
libs/m4ri-20200125/aclocal.m4
Expand Down Expand Up @@ -80,12 +79,10 @@ libs/m4ri-20200125/missing
libs/m4ri-20200125/test-driver
libs/m4ri-20200125/tests/Makefile
libs/m4ri-20200125/tests/Makefile.in
libs/m4ri-20200125/tests/.*
libs/m4ri-20200125/.libs
libs/m4ri-20200125/bench/.deps
libs/m4ri-20200125/m4ri/.deps
libs/m4ri-20200125/m4ri/.dirstamp
libs/m4ri-20200125/configure~

solvers/lingeling/lglcfg.h
solvers/lingeling/lglcflags.h
solvers/kissat_mab/build/
solvers/kissat_mab/makefile
solvers/GASPIKISSAT/build/
Expand All @@ -95,11 +92,32 @@ solvers/yalsat/config.h
solvers/yalsat/makefile
solvers/yalsat/yalsat

solvers/cadical/makefile
solvers/cadical/src/makefile
solvers/kissat/makefile
solvers/kissat/src/makefile
solvers/lingeling/ilingeling
solvers/lingeling/lglddtrace
solvers/lingeling/lglmbt
solvers/lingeling/lgluntrace
solvers/lingeling/lingeling
solvers/lingeling/plingeling
solvers/lingeling/treengeling
solvers/lingeling/lglcfg.h
solvers/lingeling/lglcflags.h

solvers/glucose/parallel/depend.mk

solvers/mapleCOMSPS/build

solvers/kissat-inc/makefile
solvers/kissat-inc/src/makefile
solvers/kissat-inc/build

*.csv

build/
solvers/yalsat/yalsat
*.la
config.status
libtool
22 changes: 22 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build
DOXYGEN ?= doxygen
DOXYFILE = doxygen-configFile
DOXYGENOUTPUT = $(SOURCEDIR)/doxygen/painless/xml

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
Loading

0 comments on commit 0aba0e6

Please sign in to comment.