Frequently Asked Questions

DocsForge tries to resolve any relative links or image links found in your markdown files automatically. However, there are always edge cases where this automatic process fails. In such cases you can either file an issue or change the link to an absolute url and the automatic process won't touch it.

DocsForge doesn't store images locally. The automatic process changes any relative image links to absolute external url. If it fails, note the following:

Your sidebar section Public API has 0 pages

If you get this error message, something is wrong with your configuration file.

Possible reasons:

  • No source files were read.

    Check that your INPUT, EXCLUDE, includeAPI, excludeAPI fields don't result in an empty file list being fed to the autodoc engine.

  • The source files are empty due to #ifdef.

    For example, consider a file my_file.h with the following content:

    #ifdef MY_DEFINE
    #define MY_DEFINE 10
    
    ... lines of code
    
    #endif

    If MY_DEFINE is not defined in any of the files being fed to the autodoc, all the above lines of code will be skipped.

    Solutions:

    1. If possible, change your code so that ifdef doesn't wrap any lines of codes.

      #ifdef MY_DEFINE
      #define MY_DEFINE 10
      #endif
      
      ... Lines of code
      
    2. If MY_DEFINE is defined in another file my_other_file.h add it to the INPUT key (so it can be read in the autodoc stage) and to excludeAPI (to exclude it from being documented)

      autodocSettings
        PublicAPI
          ...
          INPUT: 'my_file.h my_other_file.h'
          excludeApi: [my_other_file.h]
          ENABLE_PREPROCESSING: 'YES'     #default value for C/C++
      
    3. Use the PREDEFINED key to add the definition of to define MY_DEFINE for the autodoc stage.

      autodocSettings
        PublicAPI
          ...
          INPUT: 'my_file.h'
          excludeApi: []                  #default value for C/C++
          ENABLE_PREPROCESSING: 'YES'     #default value for C/C++
          PREDEFINED:
          - MY_DEFINE=10
    4. Disable ENABLE_PREPROCESSING to stop doxygen from evaluating any C-preprocessor directives.

      autodocSettings
        PublicAPI
          ...
          INPUT: 'my_file.h'
          excludeApi: []                  #default value for C/C++
          ENABLE_PREPROCESSING: 'NO'
          PREDEFINED:''                   #default value for C/C++

Add a shield icon

Shield icon links are quite popular in github repositories.

If you want to add a docs shield to your repo:

Documentation

Add the following code snippet:

[![Documentation](https://img.shields.io/badge/docs-docsforge-blue)](http://<YOUR_PROJECT_SUBDOMAIN>.docsforge.com/)






Add Discussion as Guest

Log in to DocsForge