சூரரிமாச்சிலை நீட்டிப்பு

உங்கள் Sphinx ஆவணங்களில் நேரடியாக கஃபர் வரைபடங்களைப் பயன்படுத்துவதை விட அற்புதமானது. உங்கள் டாக்சை reStructured Text அல்லது Markdown இல் எழுதினாலும், நாங்கள் உங்களை மூடிமறைத்துள்ளோம்.

Tip

மறுசீரமைக்கப்பட்ட உரை தொடரியல் இங்கே நாங்கள் உள்ளடக்குகிறோம். நீங்கள் மார்க் டவுனை விரும்பினால், MyST-parser, இது ச்பின்க்ச் வழிமுறைகளை ஆதரிப்பதால்.

ஐ அமைக்க குறைந்தபட்ச முயற்சி தேவை . வரைபடத்தைச் சேர்ப்பது மிகவும் எளிது:

.. diagram:: main

நீங்கள் பல காஃபர் மூல கோப்புகளைப் பயன்படுத்தினால், நீங்கள் ஒரு :model: பண்புக்கூறு மற்றும் மாதிரி பெயர்களை ச்பின்க்ச் உள்ளமைவு கோப்பில் (conf.py) சேர்க்க வேண்டும்.

.. diagram:: main
   :model: example

வரைபடங்களை அவற்றின் பெயரால் அல்லது அவற்றின் முழு தகுதி வாய்ந்த பெயரால் குறிப்பிடலாம்.

.. diagram:: New model.main

Figure, மற்றும் Image properties ஐப் பயன்படுத்தலாம்:

.. diagram:: main
   :figwidth: image
   :align: center
   :alt: A description suitable for an example

   You can also add a caption, if you want.

நீங்கள் விரும்பினால் ஒரு தலைப்பையும் சேர்க்கலாம்.

உள்ளமைவு

சூரரிமாச்சிலை இல் கஃபர் வரைபட ஆதரவைச் சேர்க்க, காஃபர் ஒரு சார்புநிலையாக பட்டியலிடப்பட்டுள்ளதா என்பதை உறுதிப்படுத்திக் கொள்ளுங்கள்.

Important

கஃபருக்கு குறைந்தபட்சம் பைதான் 3.9 தேவைப்படுகிறது.

இரண்டாவதாக, உங்கள் conf.py கோப்பில் பின்வருவனவற்றைச் சேர்க்கவும்:

படி 1: கஃபரை நீட்டிப்பாக சேர்க்கவும்.

extensions = [
    "gaphor.extensions.sphinx",
]

படி 2: மாதிரிகள் பற்றிய குறிப்புகளைச் சேர்க்கவும்

# A single model
gaphor_models = "../examples/sequence-diagram.gaphor"

# Or multiple models
gaphor_models = {
    "connect": "connect.gaphor",
    "example": "../examples/sequence-diagram.gaphor"
}

இப்போது உங்கள் ஆவணங்களில் diagram வழிமுறைகளைச் சேர்க்கவும்.

ஆவணத்தைப் படியுங்கள்

வரைபட கட்டளை Read the docs உடன் நன்றாக விளையாடுகிறது. வரைபடங்களை வழங்குவதற்கு, உங்கள் திட்டத்தில் .readthedocs.yaml கோப்பைப் பயன்படுத்துவது நல்லது. கீழே காட்டப்பட்டுள்ளபடி கூடுதல் apt_packages ஐச் சேர்ப்பதை உறுதிசெய்க.

இது .readthedocs.yaml கோப்பு, இதை காஃபோர்க்கு பயன்படுத்துகிறோம்:

version: 2
formats:
- htmlzip
- epub
build:
  os: ubuntu-24.04
  tools:
    python: "3.14"
  apt_packages:
  - libgirepository-2.0-dev
  - libcairo2-dev
  - pkg-config
  - python3-dev
  - gir1.2-pango-1.0
  - graphviz
  jobs:
    pre_install:
    - python3 -m pip install --upgrade pip
    - python3 -m pip install --constraint=.github/github-requirements.txt poetry poetry-plugin-export
    - poetry config virtualenvs.create false
    - poetry export --format=requirements.txt --output=requirements-only-docs.txt --only=docs
    post_install:
    - python -m pip install .
    - python -m pip install -r requirements-only-docs.txt
sphinx:
  configuration: docs/conf.py
  fail_on_warning: true

• பிகோப்செக்டை உருவாக்க libgirepositary2.0-dev தேவை.

• உரை ரெண்டரிங்கிற்கு gir1.2-pango-1.0 தேவை.

Note

Kaphor 2.7.0, gir1.2-gtk-3.0 மற்றும் gir1.2-gtksource-4 தேவை apt_packages, நாங்கள் GUI ஐப் பயன்படுத்தவில்லை என்றாலும். கஃபர் 2.7.1 இலிருந்து உங்களுக்கு தேவையானது சி-ரெபோசிட்டரி மற்றும் பாங்கோ.

பிழைகள்

ஆவணங்கள் கட்டமைக்கப்படும்போது மற்றும் ஆவணத்தில் கன்சோலில் பிழைகள் காட்டப்படுகின்றன.

ஆவணத்தில் பிழை தோன்றும். இது போன்ற ஒன்று:

Error

மாதிரியில் ‘தவறான பெயர்’ எந்த வரைபடமும் இல்லை ‘எடுத்துக்காட்டு’ (../examples/ வரிசைமுறை-diagram.gaphor).