diff --git a/doc/doxygen/.gitignore b/doc/doxygen/.gitignore index 53e838267f92..192090e7328a 100644 --- a/doc/doxygen/.gitignore +++ b/doc/doxygen/.gitignore @@ -1,2 +1,3 @@ src/css/variables.less src/changelog.md +src/coc.md diff --git a/doc/doxygen/Makefile b/doc/doxygen/Makefile index d3a9e4d453cb..f72d6db51636 100644 --- a/doc/doxygen/Makefile +++ b/doc/doxygen/Makefile @@ -16,17 +16,17 @@ doc: $(DOCUMENTATION_FORMAT) # by marking html as phony we force make to re-run Doxygen even if the directory exists. .PHONY: html -html: src/changelog.md +html: src/changelog.md src/coc.md ( cat riot.doxyfile ; echo "GENERATE_HTML = yes" ) | doxygen - @echo "" @echo "RIOT documentation successfully generated at file://$(RIOTBASE)/doc/doxygen/html/index.html" .PHONY: check -check: src/changelog.md +check: src/changelog.md src/coc.md ( cat riot.doxyfile) | doxygen - .PHONY: man -man: src/changelog.md +man: src/changelog.md src/coc.md ( cat riot.doxyfile ; echo "GENERATE_MAN = yes" ) | doxygen - 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 @./generate-changelog.py $+ $@ +src/coc.md: ../../CODE_OF_CONDUCT.md + awk 'NR == 1 {print $$0,"{#coc}"} NR > 1 {print $$0}' $< > $@ + .PHONY: latex: src/changelog.md ( cat riot.doxyfile ; echo "GENERATE_LATEX= yes" ) | doxygen - diff --git a/doc/doxygen/riot.doxyfile b/doc/doxygen/riot.doxyfile index 652318ef6fed..95f937247393 100644 --- a/doc/doxygen/riot.doxyfile +++ b/doc/doxygen/riot.doxyfile @@ -868,6 +868,10 @@ INPUT = ../../doc.txt \ src/vision.md \ src/community-processes.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-an-application.md \ src/porting-boards.md \ diff --git a/doc/doxygen/src/coc-info.md b/doc/doxygen/src/coc-info.md new file mode 100644 index 000000000000..30ce4c1e463b --- /dev/null +++ b/doc/doxygen/src/coc-info.md @@ -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