Elixir Language
ExDoc

परिचय

में प्रलेखन उत्पन्न करने के लिए HTML से प्रारूप @doc और @moduledoc अपने स्रोत कोड में गुण, जोड़ने ex_doc और एक markdown प्रोसेसर, अभी ExDoc का समर्थन करता है विशेष प्रयोजन , Pandoc , Hoedown और Cmark , अपने में निर्भरता के रूप में mix.exs फ़ाइल:

# config/mix.exs

def deps do
  [{:ex_doc, "~> 0.11", only: :dev},
   {:earmark, "~> 0.1", only: :dev}]
end

यदि आप एक और मार्कडाउन प्रोसेसर का उपयोग करना चाहते हैं, तो आप मार्किंग टूल सेक्शन में बदलाव के बारे में अधिक जानकारी पा सकते हैं।

आप Elixir @doc और @moduledoc विशेषताओं के भीतर @doc का उपयोग कर सकते हैं।

फिर, mix docs चलाएं।

एक बात का ध्यान रखें कि ExDoc कॉन्फ़िगरेशन पैरामीटर की अनुमति देता है, जैसे:

  def project do
    [app: :my_app,
     version: "0.1.0-dev",
     name: "My App",
     source_url: "https://github.com/USER/APP",
     homepage_url: "http://YOUR_PROJECT_HOMEPAGE",
     deps: deps(),
     docs: [logo: "path/to/logo.png",
            output: "docs",
            main: "README",
            extra_section: "GUIDES",
            extras: ["README.md", "CONTRIBUTING.md"]]]
  end

आप mix help docs इस कॉन्फ़िगरेशन विकल्पों के बारे में अधिक जानकारी देख सकते हैं