Guidedog / 문서 0.2.0

작은 책 만들기¶

사이트는 문서로 이루어진 그래프입니다. 책에는 읽기 순서가 필요합니다. toctree는 둘 다 제공합니다.

장 추가¶

notes/measurement.rst를 만드세요.

Measurement
===========

A measurement has a value and a unit.
Write both. A bare number leaves the reader guessing.

.. _measurement-units:

Units
-----

Keep one unit within a comparison.

notes/index.rst의 내용을 다음으로 바꾸세요.

Field Notes
===========

These notes explain how to make a comparison that another person can check.

.. toctree::
   :maxdepth: 2
   :numbered:

   measurement

Begin with :doc:`measurement`.
For the unit rule, see :ref:`measurement-units`.

문서 이름에서 .rst는 생략합니다. 레이블은 문서 안의 개념에 이름을 붙입니다. 장에는 문서 링크를, 특정 논증에는 레이블을 사용하세요.

다이어그램 추가¶

다음을 measurement.rst에 넣으세요.

.. graphviz::
   :caption: A comparison needs a common unit.
   :alt: Values are converted to one unit before they are compared.

   digraph comparison {
     rankdir=LR;
     "values" -> "common unit" -> "comparison";
   }

Guidedog는 링크된 Graphviz 라이브러리를 사용합니다. HTML에는 SVG, PDF에는 이미지가 들어가므로 브라우저용 다이어그램 해석기가 필요하지 않습니다. 캡션은 결론을, 대체 텍스트는 그림을 설명합니다.

책 빌드¶

guidedog build html notes -W
guidedog build pdf notes -W

장은 사이드바와 책의 목차에 나타납니다. 브라우저에서 절 링크를 따라가고 PDF에서도 목적지를 확인하세요.

다음으로 문서 작성을 읽어 보세요. 각 장이 한 주제를 설명할 수 있도록 짧게 유지하세요.