इस पृष्ठ पर

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 में भी उसका लक्ष्य जाँचें।

अगला उपयोगी कदम दस्तावेज़ लिखना है। हर अध्याय इतना छोटा रखें कि एक विषय समझाए।