From f4c50dd563dfe7ed2ad5e4a6e9fed22d605df5a3 Mon Sep 17 00:00:00 2001 From: Levent Kaya Date: Tue, 26 Nov 2024 02:08:32 +0300 Subject: [docs] update doxygen generation --- .github/doxygen-gh-pages.yml | 34 +++---------- docs/Doxyfile | 119 +++---------------------------------------- 2 files changed, 16 insertions(+), 137 deletions(-) diff --git a/.github/doxygen-gh-pages.yml b/.github/doxygen-gh-pages.yml index b43486d..3253ad2 100644 --- a/.github/doxygen-gh-pages.yml +++ b/.github/doxygen-gh-pages.yml @@ -1,43 +1,25 @@ -name: Deploy Doxygen Documentation +name: Generate and Deploy Doxygen Documentation on: push: branches: - - master - pull_request: - branches: - - master + - main jobs: - deploy: + build: runs-on: ubuntu-latest steps: - name: Checkout repository uses: actions/checkout@v4 - - name: Install Doxygen - run: | - sudo apt-get update - sudo apt-get install -y doxygen graphviz + - name: Set up Doxygen + run: sudo apt-get install -y doxygen graphviz - - name: Generate Doxygen Documentation - run: | - cd docs - doxygen Doxyfile - cd .. + - name: Generate Doxygen documentation + run: doxygen Doxyfile - name: Deploy to GitHub Pages - if: github.ref == 'refs/heads/master' uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./docs/html - enable_jekyll: false - full_commit_message: Deploy Doxygen documentation - - - name: List generated files - run: | - echo "Contents of docs directory:" - ls -la docs/ - echo "Contents of docs/html directory (if exists):" - ls -la docs/html/ || echo "html directory not found" \ No newline at end of file + publish_dir: docs/html diff --git a/docs/Doxyfile b/docs/Doxyfile index 6e37e03..6fc6fcf 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -1,111 +1,8 @@ -# Doxyfile for FBGL (Framebuffer Graphics Library) - -# Project information -PROJECT_NAME = "FBGL" -PROJECT_NUMBER = "0.1.0" -PROJECT_BRIEF = "Framebuffer Graphics Library" -PROJECT_LOGO = -OUTPUT_DIRECTORY = . -CREATE_SUBDIRS = NO -ALLOW_UNICODE_NAMES = NO -OUTPUT_LANGUAGE = English - -# Build settings -EXTRACT_ALL = YES -EXTRACT_PRIVATE = YES -EXTRACT_STATIC = YES -EXTRACT_LOCAL_CLASSES = YES -EXTRACT_LOCAL_METHODS = YES -EXTRACT_ANON_NSPACES = NO - -# Input files -INPUT = ../ -FILE_PATTERNS = *.h -RECURSIVE = YES -EXCLUDE = -EXCLUDE_PATTERNS = */build/* */.* -EXCLUDE_SYMBOLS = - -# Source browsing -SOURCE_BROWSER = YES -INLINE_SOURCES = YES -STRIP_CODE_COMMENTS = NO -REFERENCED_BY_RELATION = YES -REFERENCES_RELATION = YES -REFERENCES_LINK_SOURCE = YES -USE_HTAGS = NO -VERBATIM_HEADERS = YES -USE_MDFILE_AS_MAINPAGE = ../README.md - -# HTML output -GENERATE_HTML = YES -HTML_OUTPUT = html -HTML_FILE_EXTENSION = .html -HTML_HEADER = -HTML_FOOTER = -HTML_STYLESHEET = -HTML_EXTRA_STYLESHEET = -HTML_EXTRA_FILES = -HTML_COLORSTYLE_HUE = 220 -HTML_COLORSTYLE_SAT = 100 -HTML_COLORSTYLE_GAMMA = 80 -HTML_TIMESTAMP = YES -HTML_DYNAMIC_MENUS = YES -HTML_DYNAMIC_SECTIONS = NO -GENERATE_TREEVIEW = YES -ENUM_VALUES_PER_LINE = 4 -TREEVIEW_WIDTH = 250 - -# Other output formats -GENERATE_LATEX = NO -GENERATE_RTF = NO -GENERATE_MAN = NO -GENERATE_XML = NO -GENERATE_DOCBOOK = NO -GENERATE_AUTOGEN_DEF = NO -GENERATE_PERLMOD = NO - -# Preprocessing -ENABLE_PREPROCESSING = YES -MACRO_EXPANSION = YES -EXPAND_ONLY_PREDEF = NO -SEARCH_INCLUDES = YES -INCLUDE_PATH = -INCLUDE_FILE_PATTERNS = -PREDEFINED = FBGL_IMPLEMENTATION \ - FBGL_USE_FREETYPE \ - FBGL_HIDE_CURSOR -EXPAND_AS_DEFINED = -SKIP_FUNCTION_MACROS = NO - -# Dot tool settings -HAVE_DOT = YES -DOT_NUM_THREADS = 0 -CLASS_GRAPH = YES -COLLABORATION_GRAPH = YES -GROUP_GRAPHS = YES -UML_LOOK = NO -UML_LIMIT_NUM_FIELDS = 10 -DOT_UML_DETAILS = NO -DOT_WRAP_THRESHOLD = 17 -TEMPLATE_RELATIONS = NO -INCLUDE_GRAPH = YES -INCLUDED_BY_GRAPH = YES -CALL_GRAPH = NO -CALLER_GRAPH = NO -GRAPHICAL_HIERARCHY = YES -DIRECTORY_GRAPH = YES - -# General settings -OPTIMIZE_OUTPUT_FOR_C = YES -BUILTIN_STL_SUPPORT = NO -CPP_CLI_SUPPORT = NO -SIP_SUPPORT = NO -IDL_PROPERTY_SUPPORT = YES -DISTRIBUTE_GROUP_DOC = NO -GROUP_NESTED_COMPOUNDS = NO -SUBGROUPING = YES -INLINE_GROUPED_CLASSES = NO -INLINE_SIMPLE_STRUCTS = NO -TYPEDEF_HIDES_STRUCT = NO -LOOKUP_CACHE_SIZE = 0 \ No newline at end of file +PROJECT_NAME = fbgl +OUTPUT_DIRECTORY = docs +GENERATE_HTML = YES +GENERATE_LATEX = NO +INPUT = fbgl.h +FILE_PATTERNS = *.h +RECURSIVE = NO +EXTRACT_ALL = YES -- cgit v1.2.3