Commit a602c1b2 authored by Build System's avatar Build System
Browse files

Adds target to build doxygen-python documentation, that take 

pcbnew.py + doxygen-xml files, and build .i files with docstrings,
those .i files are included back again to build a pcbnew.py with
extended documentation from C++, finally we take the final pcbnew.py
to build the doxygen-python documentation
parent 4f784034

pcbnew/CMakeLists.txt

+60 −0
Original line number Original line Diff line number Diff line
@@ -288,7 +288,14 @@ if( KICAD_SCRIPTING ) 




    set( SWIG_OPTS -python -c++ -outdir ${CMAKE_CURRENT_BINARY_DIR} ${SWIG_FLAGS} )

    set( SWIG_OPTS -python -c++ -outdir ${CMAKE_CURRENT_BINARY_DIR} ${SWIG_FLAGS} )





    if( EXISTS ${CMAKE_CURRENT_BINARY_DIR}/doxygen-xml )

        set( SWIG_OPTS ${SWIG_OPTS} -DENABLE_DOCSTRINGS_FROM_DOXYGEN )

        set( SWIG_OPTS ${SWIG_OPTS} -I${CMAKE_CURRENT_BINARY_DIR}/docstrings )

    endif()



    add_custom_command( OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/pcbnew_wrap.cxx

    add_custom_command( OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/pcbnew_wrap.cxx

                        OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/pcbnew.py

        

        DEPENDS pcbcommon

        DEPENDS pcbcommon

        DEPENDS scripting/pcbnew.i

        DEPENDS scripting/pcbnew.i

        DEPENDS scripting/board.i

        DEPENDS scripting/board.i
@@ -301,6 +308,9 @@ if( KICAD_SCRIPTING ) 
        DEPENDS ../scripting/wx.i

        DEPENDS ../scripting/wx.i

        DEPENDS ../scripting/kicadplugins.i

        DEPENDS ../scripting/kicadplugins.i





        COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_CURRENT_BINARY_DIR}/docstrings

        COMMAND ${CMAKE_COMMAND} -E touch ${CMAKE_CURRENT_BINARY_DIR}/docstrings/docstrings.i # this makes docstrings.i available if it doesn't exist

        

        COMMAND ${SWIG_EXECUTABLE} ${SWIG_OPTS} -o ${CMAKE_CURRENT_BINARY_DIR}/pcbnew_wrap.cxx  scripting/pcbnew.i

        COMMAND ${SWIG_EXECUTABLE} ${SWIG_OPTS} -o ${CMAKE_CURRENT_BINARY_DIR}/pcbnew_wrap.cxx  scripting/pcbnew.i

        COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/../scripting/fixswigimports.py ${CMAKE_CURRENT_BINARY_DIR}/pcbnew.py

        COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/../scripting/fixswigimports.py ${CMAKE_CURRENT_BINARY_DIR}/pcbnew.py

        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}

        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
@@ -340,6 +350,56 @@ if( KICAD_SCRIPTING_MODULES ) 




endif()

endif()







###

# Doxygen python documentation

###



find_package( Doxygen )

if( DOXYGEN_FOUND )

    if( KICAD_SCRIPTING )

        

        # create XML files from doxygen parsing

        add_custom_target( doxygen-python-xml

            ${CMAKE_COMMAND} -E remove_directory doxygen-python-xml

            COMMAND SOURCES_DIR=${CMAKE_SOURCE_DIR} ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile_xml

            WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}

            DEPENDS Doxyfile_xml

            COMMENT "building doxygen docs into directory doxygen-python/html"

        )



        # create .i files from XML doxygen parsing, docstrings.i will include all of them

        add_custom_target( xml-to-docstrings 

            COMMAND ${CMAKE_COMMAND} -E remove_directory docstrings

            COMMAND ${CMAKE_COMMAND} -E make_directory docstrings

            COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_SOURCE_DIR}/scripting/extract-docstrings.py pcbnew.py doxygen-xml/xml docstrings

            

            COMMAND ${CMAKE_COMMAND} -E remove pcbnew.py # force removal so it will be recreated later

            COMMENT "building docstring files"

            WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}

            DEPENDS pcbnew.py

            DEPENDS doxygen-python-xml

            ) 



        # create doxygen-python html

        add_custom_target( doxygen-python

            ${CMAKE_COMMAND} -E remove_directory doxygen-python

            COMMAND PYTHON_SOURCES_TO_DOC=${CMAKE_CURRENT_BINARY_DIR}/pcbnew.py ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile_python 

            WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}

            DEPENDS Doxyfile.python

            DEPENDS xml-to-docstrings

            DEPENDS pcbnew.py



            COMMENT "building doxygen docs into directory doxygen-python/html"

        )

    endif()

else()

    message( STATUS "WARNING: Doxygen not found - doxygen-docs (Source Docs) target not created" )

endif()









###

###

# Windows resource file

# Windows resource file

###

###

pcbnew/Doxyfile_python

0 → 100644
+2281 −0

File added.

Preview size limit exceeded, changes collapsed.

pcbnew/Doxyfile_xml

0 → 100644
+315 −0
Original line number Original line Diff line number Diff line 
# Doxyfile 1.8.5



#---------------------------------------------------------------------------

# Project related configuration options

#---------------------------------------------------------------------------

DOXYFILE_ENCODING      = UTF-8

PROJECT_NAME           = "KiCad PCB EDA Suite"

PROJECT_NUMBER         =

PROJECT_BRIEF          =

PROJECT_LOGO           =

OUTPUT_DIRECTORY       = doxygen-xml

CREATE_SUBDIRS         = NO

OUTPUT_LANGUAGE        = English

BRIEF_MEMBER_DESC      = YES

REPEAT_BRIEF           = YES

ABBREVIATE_BRIEF       =

ALWAYS_DETAILED_SEC    = NO

INLINE_INHERITED_MEMB  = YES

FULL_PATH_NAMES        = NO

STRIP_FROM_PATH        =

STRIP_FROM_INC_PATH    =

SHORT_NAMES            = NO

JAVADOC_AUTOBRIEF      = YES

QT_AUTOBRIEF           = NO

MULTILINE_CPP_IS_BRIEF = NO

INHERIT_DOCS           = YES

SEPARATE_MEMBER_PAGES  = NO

TAB_SIZE               = 4

ALIASES                =

TCL_SUBST              =

OPTIMIZE_OUTPUT_FOR_C  = NO

OPTIMIZE_OUTPUT_JAVA   = NO

OPTIMIZE_FOR_FORTRAN   = NO

OPTIMIZE_OUTPUT_VHDL   = NO

EXTENSION_MAPPING      =

MARKDOWN_SUPPORT       = YES

AUTOLINK_SUPPORT       = YES

BUILTIN_STL_SUPPORT    = NO

CPP_CLI_SUPPORT        = NO

SIP_SUPPORT            = NO

IDL_PROPERTY_SUPPORT   = YES

DISTRIBUTE_GROUP_DOC   = NO

SUBGROUPING            = YES

INLINE_GROUPED_CLASSES = NO

INLINE_SIMPLE_STRUCTS  = NO

TYPEDEF_HIDES_STRUCT   = NO

LOOKUP_CACHE_SIZE      = 0

#---------------------------------------------------------------------------

# Build related configuration options

#---------------------------------------------------------------------------

EXTRACT_ALL            = YES

EXTRACT_PRIVATE        = YES

EXTRACT_PACKAGE        = NO

EXTRACT_STATIC         = YES

EXTRACT_LOCAL_CLASSES  = YES

EXTRACT_LOCAL_METHODS  = NO

EXTRACT_ANON_NSPACES   = NO

HIDE_UNDOC_MEMBERS     = NO

HIDE_UNDOC_CLASSES     = NO

HIDE_FRIEND_COMPOUNDS  = NO

HIDE_IN_BODY_DOCS      = NO

INTERNAL_DOCS          = NO

CASE_SENSE_NAMES       = YES

HIDE_SCOPE_NAMES       = NO

SHOW_INCLUDE_FILES     = YES

FORCE_LOCAL_INCLUDES   = NO

INLINE_INFO            = YES

SORT_MEMBER_DOCS       = YES

SORT_BRIEF_DOCS        = NO

SORT_MEMBERS_CTORS_1ST = NO

SORT_GROUP_NAMES       = NO

SORT_BY_SCOPE_NAME     = NO

STRICT_PROTO_MATCHING  = NO

GENERATE_TODOLIST      = YES

GENERATE_TESTLIST      = YES

GENERATE_BUGLIST       = YES

GENERATE_DEPRECATEDLIST= YES

ENABLED_SECTIONS       =

MAX_INITIALIZER_LINES  = 30

SHOW_USED_FILES        = YES

SHOW_FILES             = YES

SHOW_NAMESPACES        = YES

FILE_VERSION_FILTER    =

LAYOUT_FILE            =

CITE_BIB_FILES         =

#---------------------------------------------------------------------------

# Configuration options related to warning and progress messages

#---------------------------------------------------------------------------

QUIET                  = NO

WARNINGS               = YES

WARN_IF_UNDOCUMENTED   = YES

WARN_IF_DOC_ERROR      = YES

WARN_NO_PARAMDOC       = NO

WARN_FORMAT            = "$file:$line: $text   "

WARN_LOGFILE           =

#---------------------------------------------------------------------------

# Configuration options related to the input files

#---------------------------------------------------------------------------

INPUT                  = $(SOURCES_DIR)/kicad \

                         $(SOURCES_DIR)/pcbnew \

                         $(SOURCES_DIR)/3d-viewer \

                         $(SOURCES_DIR)/common \

                         $(SOURCES_DIR)/include \

                         $(SOURCES_DIR)/polygon \

                         $(SOURCES_DIR)/potrace

INPUT_ENCODING         = UTF-8

FILE_PATTERNS          = *.h \

                         *.cpp

RECURSIVE              = YES

EXCLUDE                = $(SOURCES_DIR)/include/boost

EXCLUDE_SYMLINKS       = NO

EXCLUDE_PATTERNS       =

EXCLUDE_SYMBOLS        =

EXAMPLE_PATH           =

EXAMPLE_PATTERNS       =

EXAMPLE_RECURSIVE      = NO

IMAGE_PATH             =

INPUT_FILTER           =

FILTER_PATTERNS        =

FILTER_SOURCE_FILES    = NO

FILTER_SOURCE_PATTERNS =

USE_MDFILE_AS_MAINPAGE =

#---------------------------------------------------------------------------

# Configuration options related to source browsing

#---------------------------------------------------------------------------

SOURCE_BROWSER         = YES

INLINE_SOURCES         = YES

STRIP_CODE_COMMENTS    = YES

REFERENCED_BY_RELATION = YES

REFERENCES_RELATION    = YES

REFERENCES_LINK_SOURCE = YES

SOURCE_TOOLTIPS        = YES

USE_HTAGS              = NO

VERBATIM_HEADERS       = YES

#---------------------------------------------------------------------------

# Configuration options related to the alphabetical class index

#---------------------------------------------------------------------------

ALPHABETICAL_INDEX     = YES

COLS_IN_ALPHA_INDEX    = 5

IGNORE_PREFIX          =

#---------------------------------------------------------------------------

# Configuration options related to the HTML output

#---------------------------------------------------------------------------

GENERATE_HTML          = NO 

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_SECTIONS  = NO

HTML_INDEX_NUM_ENTRIES = 100

GENERATE_DOCSET        = NO

DOCSET_FEEDNAME        = "Doxygen generated docs"

DOCSET_BUNDLE_ID       = org.doxygen.Project

DOCSET_PUBLISHER_ID    = org.doxygen.Publisher

DOCSET_PUBLISHER_NAME  = Publisher

GENERATE_HTMLHELP      = NO

CHM_FILE               =

HHC_LOCATION           =

GENERATE_CHI           = NO

CHM_INDEX_ENCODING     =

BINARY_TOC             = NO

TOC_EXPAND             = NO

GENERATE_QHP           = NO

QCH_FILE               =

QHP_NAMESPACE          = org.doxygen.Project

QHP_VIRTUAL_FOLDER     = doc

QHP_CUST_FILTER_NAME   =

QHP_CUST_FILTER_ATTRS  =

QHP_SECT_FILTER_ATTRS  =

QHG_LOCATION           =

GENERATE_ECLIPSEHELP   = NO

ECLIPSE_DOC_ID         = org.doxygen.Project

DISABLE_INDEX          = NO

GENERATE_TREEVIEW      = YES

ENUM_VALUES_PER_LINE   = 4

TREEVIEW_WIDTH         = 250

EXT_LINKS_IN_WINDOW    = NO

FORMULA_FONTSIZE       = 10

FORMULA_TRANSPARENT    = YES

USE_MATHJAX            = NO

MATHJAX_FORMAT         = HTML-CSS

MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest

MATHJAX_EXTENSIONS     =

MATHJAX_CODEFILE       =

SEARCHENGINE           = NO

SERVER_BASED_SEARCH    = NO

EXTERNAL_SEARCH        = NO

SEARCHENGINE_URL       =

SEARCHDATA_FILE        = searchdata.xml

EXTERNAL_SEARCH_ID     =

EXTRA_SEARCH_MAPPINGS  =

#---------------------------------------------------------------------------

# Configuration options related to the LaTeX output

#---------------------------------------------------------------------------

GENERATE_LATEX         = NO

LATEX_OUTPUT           = latex

LATEX_CMD_NAME         = latex

MAKEINDEX_CMD_NAME     = makeindex

COMPACT_LATEX          = NO

PAPER_TYPE             = a4wide

EXTRA_PACKAGES         =

LATEX_HEADER           =

LATEX_FOOTER           =

LATEX_EXTRA_FILES      =

PDF_HYPERLINKS         = NO

USE_PDFLATEX           = NO

LATEX_BATCHMODE        = NO

LATEX_HIDE_INDICES     = NO

LATEX_SOURCE_CODE      = NO

LATEX_BIB_STYLE        = plain

#---------------------------------------------------------------------------

# Configuration options related to the RTF output

#---------------------------------------------------------------------------

GENERATE_RTF           = NO

RTF_OUTPUT             = rtf

COMPACT_RTF            = NO

RTF_HYPERLINKS         = NO

RTF_STYLESHEET_FILE    =

RTF_EXTENSIONS_FILE    =

#---------------------------------------------------------------------------

# Configuration options related to the man page output

#---------------------------------------------------------------------------

GENERATE_MAN           = NO

MAN_OUTPUT             = man

MAN_EXTENSION          = .3

MAN_LINKS              = NO

#---------------------------------------------------------------------------

# Configuration options related to the XML output

#---------------------------------------------------------------------------

GENERATE_XML           = YES 

XML_OUTPUT             = xml

XML_SCHEMA             =

XML_DTD                =

XML_PROGRAMLISTING     = YES

#---------------------------------------------------------------------------

# Configuration options related to the DOCBOOK output

#---------------------------------------------------------------------------

GENERATE_DOCBOOK       = NO

DOCBOOK_OUTPUT         = docbook

#---------------------------------------------------------------------------

# Configuration options for the AutoGen Definitions output

#---------------------------------------------------------------------------

GENERATE_AUTOGEN_DEF   = NO

#---------------------------------------------------------------------------

# Configuration options related to the Perl module output

#---------------------------------------------------------------------------

GENERATE_PERLMOD       = NO

PERLMOD_LATEX          = NO

PERLMOD_PRETTY         = YES

PERLMOD_MAKEVAR_PREFIX =

#---------------------------------------------------------------------------

# Configuration options related to the preprocessor

#---------------------------------------------------------------------------

ENABLE_PREPROCESSING   = YES

MACRO_EXPANSION        = NO

EXPAND_ONLY_PREDEF     = NO

SEARCH_INCLUDES        = YES

INCLUDE_PATH           = $(SOURCES_DIR)/include \

                         $(SOURCES_DIR)/pcbnew \

                         $(SOURCES_DIR)/eeschema \

                         $(SOURCES_DIR)/gerbview

INCLUDE_FILE_PATTERNS  = *.h

PREDEFINED             =

EXPAND_AS_DEFINED      =

SKIP_FUNCTION_MACROS   = YES

#---------------------------------------------------------------------------

# Configuration options related to external references

#---------------------------------------------------------------------------

TAGFILES               =

GENERATE_TAGFILE       =

ALLEXTERNALS           = NO

EXTERNAL_GROUPS        = YES

EXTERNAL_PAGES         = YES

PERL_PATH              = /usr/bin/perl

#---------------------------------------------------------------------------

# Configuration options related to the dot tool

#---------------------------------------------------------------------------

CLASS_DIAGRAMS         = YES

MSCGEN_PATH            =

HIDE_UNDOC_RELATIONS   = YES

HAVE_DOT               = NO

DOT_NUM_THREADS        = 0

DOT_FONTNAME           = Helvetica

DOT_FONTSIZE           = 10

DOT_FONTPATH           =

CLASS_GRAPH            = YES

COLLABORATION_GRAPH    = YES

GROUP_GRAPHS           = YES

UML_LOOK               = NO

UML_LIMIT_NUM_FIELDS   = 10

TEMPLATE_RELATIONS     = YES

INCLUDE_GRAPH          = YES

INCLUDED_BY_GRAPH      = YES

CALL_GRAPH             = NO

CALLER_GRAPH           = NO

GRAPHICAL_HIERARCHY    = YES

DIRECTORY_GRAPH        = YES

DOT_IMAGE_FORMAT       = png

INTERACTIVE_SVG        = NO

DOT_PATH               =

DOTFILE_DIRS           =

MSCFILE_DIRS           =

DOT_GRAPH_MAX_NODES    = 50

MAX_DOT_GRAPH_DEPTH    = 0

DOT_TRANSPARENT        = NO

DOT_MULTI_TARGETS      = NO

GENERATE_LEGEND        = YES

DOT_CLEANUP            = YES

pcbnew/scripting/pcbnew.i

+3 −0
Original line number Original line Diff line number Diff line
@@ -31,6 +31,9 @@ 
%module pcbnew

%module pcbnew





%feature("autodoc", "1");

%feature("autodoc", "1");

#ifdef ENABLE_DOCSTRINGS_FROM_DOXYGEN

%include "docstrings.i"

#endif





%include "kicad.i"

%include "kicad.i"

scripting/extract-docstrings.py

0 → 100755
+405 −0

File added.

Preview size limit exceeded, changes collapsed.