Sphinx은 Python을위한 새로운 문서 도구입니다. 그것은 아주 좋아 보인다. 내가 궁금해하는 것은 :스핑크스를 사용하여 C++ 프로젝트를 문서화 한 사람이 있습니까?
우선 두 개의 디렉토리 트리, source 및 build을 유지하십시오. 버전 관리하에 source을 입력하십시오. build을 버전 제어하에 두지 말고 설치의 일부로 다시 설치하십시오.
두 번째로 http://sphinx.pocoo.org/intro.html#setting-up-the-documentation-sources을 읽습니다.
연습용 문서 트리를 작성하려면 sphinx-quickstart을 사용하십시오. 어떻게 작동하는지 배우려면 며칠 동안 이걸 가지고 놀아 라. 그런 다음 SVN 디렉토리에서 실제 빌드를 다시 사용하십시오.
잘 계획된 트리에서 문서를 구성하십시오. 일부 섹션은 해당 섹션에 대해 "index.rst"가 필요하고 일부 섹션은 필요하지 않습니다. 섹션이 "독립 실행 형"인 방법에 따라 다릅니다.
최상위 레벨 index.rst은 다음과 같습니다.
.. XXX documentation master file, created by sphinx-quickstart on Wed Dec 31 07:27:45 2008.
.. include:: overview.inc
.. _`requirements`:
Requirements
============
.. toctree::
:maxdepth: 1
requirements/requirements
requirements/admin
requirements/forward
requirements/volume
.. _`architecture`:
Architecture
============
.. toctree::
:maxdepth: 1
architecture/architecture
architecture/techstack
architecture/webservice_tech
architecture/webservice_arch
architecture/common_features
architecture/linux_host_architecture
Detailed Designs
================
.. toctree::
:maxdepth: 3
design/index
Installation and Operations
===========================
.. toctree::
:maxdepth: 1
deployment/installation
deployment/operations
deployment/support
deployment/load_test_results
deployment/reference
deployment/licensing
Programming and API's
=====================
.. toctree::
:maxdepth: 2
programming/index
**API Reference**. The `API Reference`_ is generated from the source.
.. _`API Reference`: ../../../apidoc/xxx/index.html
.. note::
The API reference must be built with `Epydoc`_.
.. _`Epydoc`: http://epydoc.sourceforge.net/
Management
==========
.. toctree::
:maxdepth: 2
:glob:
management/*
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
SVN Revision
============
::
$Revision: 319 $
참고로 API는 "포함"하지 않으며 일반적인 HTML 링크로 참조합니다.
스핑크스는 automodule이라는 아주 멋진 애드온을 가지고 있습니다.이 모듈은 문서 문자열을 파이썬 모듈에서 선택합니다.
업데이트 스핑크스 1.0부터 C 및 C++가 지원됩니다. http://sphinx.pocoo.org/
정말 고마워. 스핑크스가 수업과 수업을 읽었을 때 수업 및 방법에 대한 의견을 표기 한 예가 있습니까? – Nick
C++ 주석이 아닙니다. 스핑크스는 파이썬 모듈에서만 autodoc 주석을 찾을 수 있습니다. doxygen이 C++ 파일에서 주석 블록을 가져올 수있는 경우 해당 주석 블록에서 구조화 된 텍스트를 사용하고 doxygen에서 sphinx 로의 워크 플로우를 만들 수 있습니다. –
C 코드에서 autodoc 주석을 찾지 못한다면 Sphinx와 같은 시스템을 사용해야하는 이유는 무엇입니까? 저의 순진한 이해는 사람들이이 시스템을 사용하는 주된 이유였습니다. – AndyL
XML 접근 방식에 대해서는 http://www.nabble.com/Using-doxygen-and-sphinx-together-td20989904.html을보십시오.
위의 링크가 더 이상 작동하지 않는 것 같습니다.이 링크는 http://doxygen.10944.n7.nabble.com/Using-doxygen-and-sphinx-together-td3038.html 귀하가 언급 한 링크 였으면합니다. :) –
[아래에 삽입 수정] :
나는 산소 + 호흡 + 스핑크스 툴체인 (멀티 -10k) 10 개의 다른 모듈/도메인으로 구성된 C++ 라이브러리.내 바닥 라인은 다음과 같습니다 아직 완전히 사용할 수 없습니다
나에게 이러한 점을 정교 보자
나는 문제가 있었다 다음 doxygen이 마크 업 내에서
더 일반적인 의미에서 ATM은 Doxygen의 xml 출력에 대한 다리임을 알고 있어야합니다. doxygen이 정확히 무엇을 출력하는지는 위의 제한 사항과 마찬가지로 과 같은 방식으로 이해하면 안됩니다. 이 오히려 정확히 제공,
나중에 창조자를 통한 유지가 심하게 내려갈 것으로 보인다. .따라서 회사에서 일하면서 호흡을하는 상사가 에게 호소하거나 시간을 보내고 이 정말 귀중한 프로젝트를 찾고 있다고 확신 할 수 있다면 포크로 생각하십시오! 제 (일치하는 CSS 스타일) 오래된 doxygen이 문서를 참조하는 주변 튜토리얼 같은 구조를 구축 :
최종 포인터로서, 또한 중간 솔루션을 제공 할 수 스핑크스의 doxylink있는 contrib 프로젝트, 주의 (나는 스핑크스와 look'n'feels에 대한 doxygen 문서 상단에 동일한 헤더를 삽입 할 수도 있다고 생각합니다.) 그렇게하면 프로젝트가 스핑크스와 의 친 화성을 유지하며 호흡이 완전히 끝나면 으로 이동할 수 있습니다. 그러나 다시 : 호흡이 당신의 의제에 맞으면 어떤 사랑을 보일 것을 고려하십시오.
C + + 프로젝트에 Sphinx를 사용하게 되었습니까? 그렇다면 귀하의 경험은 어땠습니까? – AndyL