Skip to content

Commit 40f3b6a

Browse files
doxygen: create framework to unify markdown and source code part (#9946)
* doxygen: adjust documentation directory structure - Rename documentation/doxygen to documentation/0.doxygen and cleanup some unused files. - Add/rename folders for each sub sections, such as 1.introduction/...... Each sub section will be created as a subpage. - Generate initial Doxyfile, this Doxyfile will be used to unify doxygen generated API documents and those markdown files under documentation folder. This patch just add the default Doxyfile generated by running "doxygen -g". It is used as baseline to add more features/configurations. - Rename documentation/README.md to documentation/INDEX.md, and use it as mainpage. - Move 0.doxygen/readme.md to documentation/README.md. * doxygen: update configurations These configurations are from old documentation/doxygen/Doxyfile. Try best to compatible exixting design. * doxygen: add run script Add a script to automatic some operations. Updated the README.md. --------- Signed-off-by: Chen Wang <[email protected]> Co-authored-by: Supper Thomas <[email protected]>
1 parent c3e5152 commit 40f3b6a

File tree

133 files changed

+1078
-1052
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

133 files changed

+1078
-1052
lines changed

.github/workflows/doxygen.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -50,15 +50,15 @@ jobs:
5050
- name: generate doxygen html
5151
shell: bash
5252
run: |
53-
cd documentation/doxygen
53+
cd documentation
5454
doxygen Doxyfile
5555
cat Doxyfile
5656
5757
- name: Upload static files as artifact
5858
id: deployment
5959
uses: actions/upload-pages-artifact@main # or specific "vX.X.X" version tag for this action
6060
with:
61-
path: documentation/doxygen/html/
61+
path: documentation/html/
6262

6363
deploy:
6464
if: github.event_name == 'push'

README.md

+1-1

README_de.md

+1-1

README_es.md

+1-1

README_zh.md

+2-2
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

documentation/introduction/introduction.md documentation/1.introduction/introduction.md

+4-4

documentation/quick-start/keil-installation/keil-installation.md documentation/2.quick-start/keil-installation/keil-installation.md

+1-1

documentation/quick-start/quick-start.md documentation/2.quick-start/quick-start.md

+8-8

documentation/3.kernel/INDEX.md

+10

documentation/4.tool/INDEX.md

+5

documentation/5.device/INDEX.md

+14

documentation/6.components/INDEX.md

+12

documentation/7.contribution/INDEX.md

+9

0 commit comments

Comments
 (0)