kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-15 09:33:50 +01:00
Code Releases Activity

doc: add CoC information to documentation

Browse Source
This commit is contained in:
Martine Lenders 2024-12-10 16:02:23 +01:00
parent a5a942b1fb
commit 6bca56bb67
No known key found for this signature in database
GPG Key ID: 2134D77A5336DD80
4 changed files with 19 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/doxygen/.gitignore vendored
View File

@ -1,2 +1,3 @@
src/css/variables.less src/css/variables.less
src/changelog.md src/changelog.md
src/coc.md

9
doc/doxygen/Makefile
View File

@ -16,17 +16,17 @@ doc: $(DOCUMENTATION_FORMAT)
# by marking html as phony we force make to re-run Doxygen even if the directory exists. # by marking html as phony we force make to re-run Doxygen even if the directory exists.
.PHONY: html .PHONY: html
html: src/changelog.md html: src/changelog.md src/coc.md
( cat riot.doxyfile ; echo "GENERATE_HTML = yes" ) | doxygen - ( cat riot.doxyfile ; echo "GENERATE_HTML = yes" ) | doxygen -
@echo "" @echo ""
@echo "RIOT documentation successfully generated at file://$(RIOTBASE)/doc/doxygen/html/index.html" @echo "RIOT documentation successfully generated at file://$(RIOTBASE)/doc/doxygen/html/index.html"
.PHONY: check .PHONY: check
check: src/changelog.md check: src/changelog.md src/coc.md
( cat riot.doxyfile) | doxygen - ( cat riot.doxyfile) | doxygen -
.PHONY: man .PHONY: man
man: src/changelog.md man: src/changelog.md src/coc.md
( cat riot.doxyfile ; echo "GENERATE_MAN = yes" ) | doxygen - ( cat riot.doxyfile ; echo "GENERATE_MAN = yes" ) | doxygen -
src/css/riot.css: src/css/riot.less src/css/variables.less src/css/riot.css: src/css/riot.less src/css/variables.less
@ -39,6 +39,9 @@ src/css/variables.less: src/config.json
src/changelog.md: src/changelog.md.tmp ../../release-notes.txt src/changelog.md: src/changelog.md.tmp ../../release-notes.txt
@./generate-changelog.py $+ $@ @./generate-changelog.py $+ $@
src/coc.md: ../../CODE_OF_CONDUCT.md
awk 'NR == 1 {print $$0,"{#coc}"} NR > 1 {print $$0}' $< > $@
.PHONY: .PHONY:
latex: src/changelog.md latex: src/changelog.md
( cat riot.doxyfile ; echo "GENERATE_LATEX= yes" ) | doxygen - ( cat riot.doxyfile ; echo "GENERATE_LATEX= yes" ) | doxygen -

4
doc/doxygen/riot.doxyfile
View File

@ -868,6 +868,10 @@ INPUT = ../../doc.txt \
src/vision.md \ src/vision.md \
src/community-processes.md \ src/community-processes.md \
src/roadmap.md \ src/roadmap.md \
src/coc-info.md \
src/coc.md \
src/coc-reporting-guide.md \
src/coc-faq.md \
src/creating-modules.md \ src/creating-modules.md \
src/creating-an-application.md \ src/creating-an-application.md \
src/porting-boards.md \ src/porting-boards.md \

8
doc/doxygen/src/coc-info.md Normal file
View File

@ -0,0 +1,8 @@
Code of Conduct Information {#coc-info}
===========================
The following documents are describing all matters around our code of conduct:
- The \subpage coc itself,
- The \subpage coc-reporting-guide, and
- The \subpage coc-faq