mirror of
https://github.com/AntonioND/palib.git
synced 2025-06-18 14:45:43 -04:00
docs: Cleanup documentation generation scripts
This commit is contained in:
parent
5dd1bda483
commit
65b22aeba9
2
docs/.gitignore
vendored
Normal file
2
docs/.gitignore
vendored
Normal file
@ -0,0 +1,2 @@
|
||||
english/
|
||||
french/
|
2819
docs/Doxyfile_English
Normal file
2819
docs/Doxyfile_English
Normal file
File diff suppressed because it is too large
Load Diff
2819
docs/Doxyfile_French
Normal file
2819
docs/Doxyfile_French
Normal file
File diff suppressed because it is too large
Load Diff
@ -1,34 +1,18 @@
|
||||
PAlib documentation folder
|
||||
==========================
|
||||
|
||||
Instructions for normal users
|
||||
-----------------------------
|
||||
This directory contains Doxygen configuration files to generate PAlib
|
||||
documentation in two languages, English and French.
|
||||
|
||||
This directory contains the PAlib documentation in two languages,
|
||||
English and French. Just go to the subfolder of your choice to
|
||||
pick a language.
|
||||
|
||||
Each language subfolder has three versions of the documentation:
|
||||
- PAlib.chm - The CHM version for use with Windows.
|
||||
- PAlib.pdf - The printable PDF version.
|
||||
- /html/ subfolder - The browsable HTML version.
|
||||
|
||||
Instructions for developers
|
||||
---------------------------
|
||||
|
||||
The folder dev contains tools/scripts to generate the documentation.
|
||||
By default it's set up for a Windows system with PAlib installed in
|
||||
the folder C:\devkitPro\PAlib, but you can adapt it by:
|
||||
|
||||
- Changing the STRIP_FROM_PATH and the HHC_LOCATION variable.
|
||||
- Disabling the .chm creation support (GENERATE_HTMLHELP = NO)
|
||||
because it depends on a Windows executable.
|
||||
Each language subfolder has two versions of the documentation:
|
||||
- PAlib.pdf - The printable PDF version.
|
||||
- html subfolder - The browsable HTML version.
|
||||
|
||||
To generate the documentation you need the following installed:
|
||||
- Doxygen
|
||||
- MikTeX on Windows or pdfTeX on other OSes
|
||||
|
||||
Just run the appropiate batch file on Windows or follow these steps:
|
||||
- Run "doxygen Doxyfile_[Language]" where Language is the language
|
||||
you want to generate the documentation for.
|
||||
- Run make on the [Language]/latex folder.
|
||||
- From the root of this repository, run "doxygen docs/Doxyfile_[Language]"
|
||||
where Language is the language you want to generate the documentation for.
|
||||
- Run make on the docs/[Language]/latex folder.
|
||||
|
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -1,26 +0,0 @@
|
||||
@echo off
|
||||
rd /s /q ..\english
|
||||
cls
|
||||
|
||||
echo Running Doxygen...
|
||||
pause
|
||||
echo.
|
||||
|
||||
doxygen Doxyfile_English
|
||||
|
||||
echo.
|
||||
echo Converting LaTeX to PDF...
|
||||
pause
|
||||
echo.
|
||||
|
||||
cd ..\english\latex
|
||||
make > NUL
|
||||
|
||||
cd..
|
||||
|
||||
copy latex\refman.pdf PAlib.pdf
|
||||
rd /s /q latex
|
||||
|
||||
echo.
|
||||
echo Documentation successfully generated.
|
||||
pause
|
@ -1,26 +0,0 @@
|
||||
@echo off
|
||||
rd /s /q ..\french
|
||||
cls
|
||||
|
||||
echo Running Doxygen...
|
||||
pause
|
||||
echo.
|
||||
|
||||
doxygen Doxyfile_French
|
||||
|
||||
echo.
|
||||
echo Converting LaTeX to PDF...
|
||||
pause
|
||||
echo.
|
||||
|
||||
cd ..\french\latex
|
||||
make > NUL
|
||||
|
||||
cd..
|
||||
|
||||
copy latex\refman.pdf PAlib.pdf
|
||||
rd /s /q latex
|
||||
|
||||
echo.
|
||||
echo Documentation successfully generated.
|
||||
pause
|
BIN
docs/dev/hha.dll
BIN
docs/dev/hha.dll
Binary file not shown.
BIN
docs/dev/hhc.exe
BIN
docs/dev/hhc.exe
Binary file not shown.
Loading…
Reference in New Issue
Block a user