PHP 프로젝트 문서에 스핑크스 사용

PHP 프로젝트 문서를 효율적으로 작성 : Sphinx and Readthedocs Guide 이 기사는 Sphinx 및 ReadTheDoc을 사용하여 설치, 테마 사용자 정의, PHP 구문 하이라이트, ReadTheDocs 배포 등과 같은 주요 단계를 다루는 고품질 PHP 프로젝트 문서를 만드는 방법을 안내합니다.

코어 포인트 :

SPHINX 설치는 ReadTHEDOCS와 통합합니다.

SPHINX를 사용하여 ReadThedocs를 결합하고 REST 및 Markdown 형식을 지원하여 전문 PHP 프로젝트 문서를 쉽게 만들 수 있습니다. 권장 폴더 구조 : 프로젝트 조직을 최적화하려면 문서와 프로젝트 코드를 동일한 폴더에 배치하거나 프로젝트 크기를 기반으로 독립 코드 리포지토리를 작성하는 것이 좋습니다.

사용자 정의 테마 :
• 설치 및 구성을 통해 문서의 미학을 향상시키고 사용자 경험을 향상시킵니다. PHP 구문 강조 및 도메인 구성 : PHP 코드 구문 하이라스 및보다 정확한 PHP 언어 지원을 구현하기 위해 확장자 설치 및 코드 가독성을 향상시키기 위해 확장자 설치 : 확장 설치. READTHEDOCS 배포 및 확장 : 쉽게 액세스하고 관리 할 수 ​​있도록 readthedocs에 문서를 배포하고 확장 강화를 활용합니다.
• READTHEDOCS는 업계에서 널리 사용되는 문서 호스팅 플랫폼입니다. 지역 빌드 및 온라인 호스팅을 지원하므로 개발자가 버전 제어 및 팀 협업을보다 쉽게 ​​수행 할 수 있습니다.
빠른 시작 :
• 다음 명령은 Sphinx 문서 환경을 신속하게 구축 할 수 있습니다. Quick Startup을 완료 한 후 테마 및 PHP 구문 하이라스 활성화 : 빌드 html 문서 : sphinx_rtd_theme
또는
• 스핑크스 설치 : READTHEDOCS는 기본 레이어에서 스핑크스를 사용하므로 스핑크스와 그 종속성을 설치해야합니다. 필요한 도구를 설치하려면 를 사용하십시오. sphinxcontrib-phpdomain 권장 폴더 구조 :
• 문서는 프로젝트 코드와 동일한 폴더 또는 별도의 코드 저장소에 배치 할 수 있습니다. 소규모 프로젝트는 와 같은 프로젝트 폴더에 문서를 배치하는 것이 좋습니다. 파일을 사용하여 프로젝트 릴리스에서 문서를 쉽게 제외하십시오.
사용자 정의 테마 :

테마를 설치하여 파일에 구성하십시오 :

디렉토리 구조 :

프로세스에서는 기본 문서 파일 이름 (일반적으로 )을 지정해야합니다. 기본 문서는 명령을 사용하여 디렉토리를 생성합니다.

PHP 구문 강조 표시 :

PHP 구문 강조 표시를 활성화하려면 다음 코드를 파일에 추가합니다. <strong> </strong>

PHP 필드 :

install source/conf.py 확장 된 향상된 php 언어 지원 : 소스 코드보기 :

sudo pip install sphinx sphinx-autobuild sphinx_rtd_theme sphinxcontrib-phpdomain
mkdir docs
cd docs
sphinx-quickstart
wget https://gist.githubusercontent.com/Swader/b16b18d50b8224f83d74/raw/b3c1d6912aefc390da905c8b2bb3660f513af713/requirements.txt

<p>에 다음 코드를 추가하여 문서에 GitHub 소스 코드 링크를 표시합니다. <img src="/static/imghw/default1.png" data-src="https://img.php.cn/upload/article/000/000/000/173975942118201.jpg" class="lazy" alt="Using Sphinx for PHP Project Documentation " /> </p> <<> <p> <strong> <<> 휴식과 마크 다운 : <🎜 🎜> <🎜 🎜> Sphinx는 REST 및 Markdown을 지원합니다. 마크 다운을 지원하기 위해 <🎜 🎜> 확장자를 설치하고 <🎜 </strong> : <🎜 🎜>를 구성하십시오. </p> <p> <<> ReadTheCs 배포 : <🎜 🎜> <code>sphinxcontrib-phpdomain ReadThedocs에서 새 프로젝트를 작성하고 GitHub 저장소를 연결하여 문서를 자동으로 빌드하고 배포하십시오. sudo pip install sphinxcontrib-phpdomain conf.py <<> READTHEDOCS EXTENSION : <🎜 🎜> extensions = ["sphinxcontrib.phpdomain"]

의 종속성을 나열하고 readthedocs 프로젝트 설정에서 파일 경로를 지정하기 위해

파일을 만듭니다. <<> faqs : <🎜 🎜>

<<> (기사가 너무 길고 콘텐츠가 기존 콘텐츠에서 복제되거나 기본적이기 때문에 원본 문서의 FAQ 부분은 여기서 생략됩니다. 필요한 경우 FAQ 질문을 별도로 요청할 수 있습니다.) > conf.py <🎜 🎜> <<> 요약 :

<🎜 🎜> 이 기사에서는 Sphinx 및 ReadTheDoc을 사용하여 PHP 프로젝트 문서를 작성하는 완전한 프로세스를 소개합니다. 합리적인 구성 및 테마 사용자 정의를 통해 프로젝트의 전문성과 유지 가능성을 향상시키는 아름답고 관리하기 쉬운 액세스 권한 문서를 만들 수 있습니다.

sed -i '/extensions = \[\]/ c\extensions = \["sphinxcontrib.phpdomain"\]' source/conf.py
echo '

import sphinx_rtd_theme
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

# 设置PHP语法高亮
from sphinx.highlighting import lexers
from pygments.lexers.web import PhpLexer
lexers["php"] = PhpLexer(startinline=True, linenos=1)
lexers["php-annotations"] = PhpLexer(startinline=True, linenos=1)
primary_domain = "php"

' >> source/conf.py

위 내용은 PHP 프로젝트 문서에 스핑크스 사용의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!