From 65728dc2cd180fe40360e4a849b32161b5db2f4d Mon Sep 17 00:00:00 2001 From: Joshua Henderson Date: Fri, 2 Mar 2018 10:13:21 -0700 Subject: [PATCH] rename doc dir to docs To be consistent with other projects, use the same directory name for docs. Signed-off-by: Joshua Henderson --- .gitignore | 1 - Makefile.am | 8 ++++---- README.md | 6 +++--- configure.ac | 2 +- {doc => docs}/.gitignore | 1 + Doxyfile.in => docs/Doxyfile.in | 10 +++++----- {doc => docs}/config.md | 0 {doc => docs}/logo.png | Bin {doc => docs}/logo.xcf | Bin {doc => docs}/logo55.png | Bin {doc => docs}/logo_small.xcf | Bin {doc => docs}/microchip_logo.png | Bin include/planes/engine.h | 2 +- libplanes.pc.in | 2 +- 14 files changed, 16 insertions(+), 16 deletions(-) rename {doc => docs}/.gitignore (57%) rename Doxyfile.in => docs/Doxyfile.in (99%) rename {doc => docs}/config.md (100%) rename {doc => docs}/logo.png (100%) rename {doc => docs}/logo.xcf (100%) rename {doc => docs}/logo55.png (100%) rename {doc => docs}/logo_small.xcf (100%) rename {doc => docs}/microchip_logo.png (100%) diff --git a/.gitignore b/.gitignore index e40bc93..93e2bb1 100644 --- a/.gitignore +++ b/.gitignore @@ -24,4 +24,3 @@ Makefile.in /apps/grab /apps/render /apps/dfblayers -/Doxyfile \ No newline at end of file diff --git a/Makefile.am b/Makefile.am index d0a85c7..74827a9 100644 --- a/Makefile.am +++ b/Makefile.am @@ -2,9 +2,9 @@ AUTOMAKE_OPTIONS = subdir-objects ACLOCAL_AMFLAGS = -I m4 SUBDIRS = src apps python -EXTRA_DIST = README.md COPYING Doxyfile.in +EXTRA_DIST = README.md COPYING docs/Doxyfile.in -.PHONY: doc +.PHONY: docs -doc: Doxyfile - @doxygen +docs: docs/Doxyfile + @cd docs && doxygen diff --git a/README.md b/README.md index 6362b36..df393df 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -![Microchip](doc/microchip_logo.png) +![Microchip](docs/microchip_logo.png) # Microchip Hardware LCD Plane Library @@ -59,9 +59,9 @@ configure line: If you have doxygen installed, you can generate the API documentation by running: - make doc + make docs -The resulting documentation will be in the doc directory. +The resulting documentation will be in the docs directory. ## Python Bindings diff --git a/configure.ac b/configure.ac index 8773290..853b4b7 100644 --- a/configure.ac +++ b/configure.ac @@ -127,5 +127,5 @@ AC_CONFIG_FILES([Makefile apps/Makefile python/Makefile libplanes.pc - Doxyfile]) + docs/Doxyfile]) AC_OUTPUT diff --git a/doc/.gitignore b/docs/.gitignore similarity index 57% rename from doc/.gitignore rename to docs/.gitignore index 2ec816f..97739db 100644 --- a/doc/.gitignore +++ b/docs/.gitignore @@ -1,2 +1,3 @@ html latex +Doxyfile \ No newline at end of file diff --git a/Doxyfile.in b/docs/Doxyfile.in similarity index 99% rename from Doxyfile.in rename to docs/Doxyfile.in index fab230f..db99e8c 100644 --- a/Doxyfile.in +++ b/docs/Doxyfile.in @@ -38,7 +38,7 @@ PROJECT_NAME = # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = +PROJECT_NUMBER = @PACKAGE_VERSION@ # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a @@ -51,14 +51,14 @@ PROJECT_BRIEF = # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. -PROJECT_LOGO = doc/logo55.png +PROJECT_LOGO = logo55.png # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. -OUTPUT_DIRECTORY = doc +OUTPUT_DIRECTORY = . # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and @@ -771,7 +771,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = include src README.md doc +INPUT = ../include ../src ../README.md . # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -1140,7 +1140,7 @@ HTML_EXTRA_STYLESHEET = # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_FILES = doc/microchip_logo.png +HTML_EXTRA_FILES = microchip_logo.png # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the style sheet and background images according to diff --git a/doc/config.md b/docs/config.md similarity index 100% rename from doc/config.md rename to docs/config.md diff --git a/doc/logo.png b/docs/logo.png similarity index 100% rename from doc/logo.png rename to docs/logo.png diff --git a/doc/logo.xcf b/docs/logo.xcf similarity index 100% rename from doc/logo.xcf rename to docs/logo.xcf diff --git a/doc/logo55.png b/docs/logo55.png similarity index 100% rename from doc/logo55.png rename to docs/logo55.png diff --git a/doc/logo_small.xcf b/docs/logo_small.xcf similarity index 100% rename from doc/logo_small.xcf rename to docs/logo_small.xcf diff --git a/doc/microchip_logo.png b/docs/microchip_logo.png similarity index 100% rename from doc/microchip_logo.png rename to docs/microchip_logo.png diff --git a/include/planes/engine.h b/include/planes/engine.h index e88edd2..4f646b9 100644 --- a/include/planes/engine.h +++ b/include/planes/engine.h @@ -92,7 +92,7 @@ enum { /** * Parse a JSON plane configuration file and populate the planes array. * - * See @ref doc/config.md for information on the config file format. + * See @ref docs/config.md for information on the config file format. * * @note This will overwrite anything that may already be in the array. * diff --git a/libplanes.pc.in b/libplanes.pc.in index b661a5f..f371d58 100644 --- a/libplanes.pc.in +++ b/libplanes.pc.in @@ -4,7 +4,7 @@ libdir=@libdir@ includedir=@includedir@ Name: libplanes -Description: Utility library for working with hardware planes +Description: Microchip library for working with hardware LCD planes Version: @PACKAGE_VERSION@ Libs: -L${libdir} -lplanes Cflags: -I${includedir} -I${includedir}/planes