콘텐츠로 이동

ReadTheDocs Mkdocs


  • Mkdocs 의 전체구조
    • mkdocs.yml 관리
    • docs/readthedoc_requirements.txt Python Package 관리
    • Doxyfile_mkdocs Doxygen 설정 별도 관리

주의 Markdown 만 지원



Python Package Mkdocs


  • docs/readthedoc_requirements.txt 
    mkdocs
mkdocs-material
mkdocs-mermaid2-plugin
pymdown-extensions


ReadtheDocs Mkdocs 설정


  • ReadtheDocs Mkdocs 설정관리

.readthedocs_mkdocs.yml 

# .readthedocs.yml
version: 2

build:
  os: ubuntu-22.04
  tools:
    python: "3.12"
  apt_packages:
    - doxygen    
    - graphviz
  jobs:
    pre_build:
      - doxygen Doxyfile_mkdocs  
    post_install:
      - pip install -r docs/readthedoc_requirements.txt

mkdocs:
  configuration: mkdocs.yml

formats:
  - htmlzip
  - pdf
  - epub


  • Readthedocs 최종 변경

.readthedocs_mkdocs.yml -> .readthedocs.yml 변경


ReadTheDocs 확인


ReadTheDocs