🖐🏿 📡 👆🏼 जूलिया। रिपोर्ट और दस्तावेज़ जेनरेटर 🙍 🖥️ 👩🏾‍⚕️

हर समय दबाने वाली समस्याओं में से एक रिपोर्ट तैयार करने की समस्या है। चूंकि जूलिया एक ऐसी भाषा है जिसके उपयोगकर्ता डेटा विश्लेषण के कार्यों से सीधे जुड़े हुए हैं, गणना और रिपोर्ट के परिणामों के साथ लेख और सुंदर प्रस्तुतियां तैयार करते हैं, इसलिए इस विषय को आसानी से अनदेखा नहीं किया जा सकता है।

प्रारंभ में, इस लेख ने रिपोर्ट बनाने के लिए व्यंजनों का एक सेट की योजना बनाई, लेकिन रिपोर्टों के बगल में प्रलेखन का विषय है, जिसके साथ रिपोर्ट जनरेटर के कई चौराहे हैं। इसलिए, इसमें कुछ मार्कअप के साथ टेम्पलेट में जूलिया निष्पादन योग्य कोड को एम्बेड करने की संभावना की कसौटी पर उपकरण शामिल हैं। अंत में, हम ध्यान दें कि समीक्षा में रिपोर्ट जनरेटर शामिल थे, दोनों जूलिया पर ही लागू किए गए थे, और अन्य प्रोग्रामिंग भाषाओं में लिखे गए उपकरण। खैर, निश्चित रूप से, जूलिया भाषा के कुछ प्रमुख बिंदुओं को नजरअंदाज नहीं किया गया था, जिसके बिना यह स्पष्ट नहीं हो सकता है कि किन मामलों में और किन साधनों का उपयोग किया जाना चाहिए।

ज्यूपिटर नोटबुक

यह उपकरण, शायद, डेटा विश्लेषण में शामिल लोगों में सबसे लोकप्रिय के लिए जिम्मेदार ठहराया जाना चाहिए। विभिन्न कम्प्यूटेशनल कोर को जोड़ने की क्षमता के कारण, यह शोधकर्ताओं और गणितज्ञों के साथ लोकप्रिय है जो अपनी विशिष्ट प्रोग्रामिंग भाषाओं के लिए उपयोग किए जाते हैं, जिनमें से एक जूलिया है। जूलिया भाषा के लिए संबंधित मॉड्यूल पूरी तरह से ज्यूपिटर नोटबुक के लिए लागू किए गए हैं। और इसीलिए यहाँ नोटबुक का उल्लेख किया गया है।
Jupyter नोटबुक स्थापना प्रक्रिया जटिल नहीं है। आदेश के लिए, https://github.com/JuliaLang/IJulia.jl देखें यदि ज्यूपिटर नोटबुक पहले से स्थापित है, तो आपको बस इज़ुलिया पैकेज स्थापित करने और संबंधित कंप्यूटिंग कोर को पंजीकृत करने की आवश्यकता है।

चूंकि जुपिटर नोटबुक उत्पाद को विस्तार से नहीं लिखने के लिए पर्याप्त रूप से जाना जाता है, हम केवल कुछ बिंदुओं का उल्लेख करेंगे। नोटपैड (हम नोटपैड शब्दावली का उपयोग करेंगे) एक ज्यूपिटर नोटबुक में ब्लॉक होते हैं, जिनमें से प्रत्येक में कोड या मार्कअप हो सकते हैं इसके विभिन्न रूपों (उदाहरण के लिए, मार्कडाउन)। प्रसंस्करण का परिणाम या तो मार्कअप (पाठ, सूत्र, आदि) का दृश्य है, या अंतिम ऑपरेशन का परिणाम है। यदि एक अर्धविराम को कोड के साथ पंक्ति के अंत में रखा गया है, तो परिणाम प्रदर्शित नहीं किया जाएगा।

उदाहरण। निष्पादन से पहले नोटबुक को निम्न आकृति में दिखाया गया है:

इसके कार्यान्वयन का परिणाम निम्नलिखित आकृति में दिखाया गया है।

नोटपैड में ग्राफिक्स और कुछ टेक्स्ट होते हैं। ध्यान दें कि मैट्रिक्स को आउटपुट करने के लिए, DataFrame प्रकार का उपयोग करना संभव है, जिसके लिए परिणाम आवश्यक होने पर स्पष्ट सीमाओं और एक DataFrame साथ एक html तालिका के रूप में प्रदर्शित किया जाता है।

Jupyter नोटबुक HTML फ़ाइल में वर्तमान नोटबुक निर्यात कर सकती है। यदि कोई रूपांतरण उपकरण स्थापित हैं, तो यह पीडीएफ में परिवर्तित हो सकता है।

कुछ नियमों के अनुसार रिपोर्ट बनाने के लिए, आप nbconvert मॉड्यूल और निम्न कमांड का उपयोग कर सकते हैं, जिसे शेड्यूल के अनुसार पृष्ठभूमि में कहा जाता है:
jupyter nbconvert --to html --execute julia_filename.ipynb

लंबी गणना करते समय, टाइमआउट का संकेत देने वाले विकल्प को जोड़ने की सलाह दी जाती है - --ExecutePreprocessor.timeout=180

इस फ़ाइल से उत्पन्न एक html रिपोर्ट वर्तमान निर्देशिका में दिखाई देगी। यहाँ --execute विकल्प का अर्थ है, शुरू करने के लिए मजबूर करना।

nbconvert मॉड्यूल nbconvert के एक पूरे सेट के लिए nbconvert देखें
https://nbconvert.readthedocs.io/en/latest/usage.html

HTML में रूपांतरण का परिणाम पिछले आंकड़े के साथ लगभग पूरी तरह से संगत है, सिवाय इसके कि इसमें मेनू बार या बटन नहीं हैं।

Jupytext

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

हम कमांड का उपयोग करके पहले माना गया उदाहरण बदल सकते हैं
jupytext --to julia julia_filename.ipynb

नतीजतन, हमें जूलिया कोड और विशेष मार्कअप के साथ julia_filename.jl फाइल julia_filename.jl और टिप्पणियों के रूप में विशेष मार्कअप मिलता है।

 # --- # jupyter: # jupytext: # text_representation: # extension: .jl # format_name: light # format_version: '1.3' # jupytext_version: 0.8.6 # kernelspec: # display_name: Julia 1.0.3 # language: julia # name: julia-1.0 # --- # # Report example using Plots, DataFrames # ### Drawing # Good time to show some plot plot(rand(5,5), linewidth=2, title="My Plot", size = (500, 200)) # ## Some computational results rand(2, 3) DataFrame(rand(2, 3))

नोट ब्लॉक विभाजक सिर्फ डबल लाइन फीड हैं।

हम कमांड का उपयोग करके उलटा परिवर्तन कर सकते हैं:
jupytext --to notebook julia_filename.jl

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

विवरण देखें https://github.com/mwouts/jupytext

जुपीटेक्स्ट और जुपिटर नोटबुक की सामान्य खामी यह है कि रिपोर्ट की "सुंदरता" इन उपकरणों की क्षमताओं द्वारा सीमित है।

स्व-निर्मित HTML

यदि किसी कारण से हम मानते हैं कि जुपिटर नोटबुक बहुत भारी उत्पाद है, तो कई तृतीय-पक्ष पैकेजों की स्थापना की आवश्यकता होती है, जो जूलिया को काम करने के लिए आवश्यक नहीं हैं, या लचीले नहीं हैं जो हमें आवश्यक रिपोर्ट फॉर्म बनाने के लिए है, तो एक वैकल्पिक तरीका मैन्युअल रूप से HTML पेज बनाना है। हालांकि, यहां आपको इमेजिंग की सुविधाओं में थोड़ा गोता लगाना होगा।

जूलिया के लिए, आउटपुट स्ट्रीम में कुछ आउटपुट करने का एक विशिष्ट तरीका Base.write फंक्शन का उपयोग करना है, और सजाने के लिए, Base.show(io, mime, x) । इसके अलावा, अनुरोध किए गए विभिन्न माइम आउटपुट तरीकों के लिए, विभिन्न प्रदर्शन विकल्प हो सकते हैं। उदाहरण के लिए, पाठ के रूप में प्रदर्शित होने पर DataFrame को छद्म ग्राफिक तालिका द्वारा प्रदर्शित किया जाता है।

 julia> show(stdout, MIME"text/plain"(), DataFrame(rand(3, 2))) 3×2 DataFrame │ Row │ x1 │ x2 │ │ │ Float64 │ Float64 │ ├─────┼──────────┼───────────┤ │ 1 │ 0.321698 │ 0.939474 │ │ 2 │ 0.933878 │ 0.0745969 │ │ 3 │ 0.497315 │ 0.0167594 │

यदि, mime को text/html रूप में निर्दिष्ट किया जाता है, तो परिणाम HTML मार्कअप है।

 julia> show(stdout, MIME"text/html"(), DataFrame(rand(3, 2))) <table class="data-frame"> <thead> <tr><th></th><th>x1</th><th>x2</th></tr> <tr><th></th><th>Float64</th><th>Float64</th></tr> </thead> <tbody><p>3 rows × 2 columns</p> <tr><th>1</th><td>0.640151</td><td>0.219299</td></tr> <tr><th>2</th><td>0.463402</td><td>0.764952</td></tr> <tr><th>3</th><td>0.806543</td><td>0.300902</td></tr> </tbody> </table>

अर्थात्, संबंधित डेटा प्रकार (तीसरे तर्क) और संबंधित आउटपुट प्रारूप के लिए परिभाषित show फ़ंक्शन के तरीकों का उपयोग करके, किसी भी वांछित डेटा प्रारूप में फ़ाइल के गठन को सुनिश्चित करना संभव है।

छवियों के साथ स्थिति अधिक जटिल है। अगर हमें एक सिंगल html फाइल बनाने की जरूरत है, तो इमेज को पेज कोड में एम्बेड किया जाना चाहिए।

उस उदाहरण पर विचार करें जिसमें यह लागू किया गया है। फ़ाइल में आउटपुट Base.write फ़ंक्शन द्वारा किया जाएगा, जिसके लिए हम उपयुक्त विधियों को परिभाषित करते हैं। तो कोड:

 #!/usr/bin/env julia using Plots using Base64 using DataFrames #        p = plot(rand(5,5), linewidth=2, title="My Plot", size = (500, 200)) #  ,  ,    @show typeof(p) # => typeof(p) = Plots.Plot{Plots.GRBackend} #    ,   3  #     abstract type Png end abstract type Svg end abstract type Svg2 end #  Base.write      #         #   —   ,  #   Base64-. #  HTML  img src="data:image/png;base64,..." function Base.write(file::IO, ::Type{Png}, p::Plots.Plot) local io = IOBuffer() local iob64_encode = Base64EncodePipe(io); show(iob64_encode, MIME"image/png"(), p) close(iob64_encode); write(file, string("<img src=\"data:image/png;base64, ", String(take!(io)), "\" alt=\"fig.png\"/>\n")) end #     Svg function Base.write(file::IO, ::Type{Svg}, p::Plots.Plot) local io = IOBuffer() show(io, MIME"image/svg+xml"(), p) write(file, replace(String(take!(io)), r"<\?xml.*\?>" => "" )) end #    XML-  ,  SVG Base.write(file::IO, ::Type{Svg2}, p::Plots.Plot) = show(file, MIME"image/svg+xml"(), p) #     DataFrame Base.write(file::IO, df::DataFrame) = show(file, MIME"text/html"(), df) #   out.html   HTML open("out.html", "w") do file write(file, """ <!DOCTYPE html> <html> <head><title>Test report</title></head> <body> <h1>Test html</h1> """) write(file, Png, p) write(file, "<br/>") write(file, Svg, p) write(file, "<br/>") write(file, Svg2, p) write(file, DataFrame(rand(2, 3))) write(file, """ </body> </html> """) end

चित्र बनाने के लिए, Plots.GRBackend इंजन का उपयोग डिफ़ॉल्ट रूप से किया जाता है, जो रेखापुंज या वेक्टर छवि आउटपुट कर सकता है। show फ़ंक्शन के mime तर्क में किस प्रकार को निर्दिष्ट किया गया है, इसके आधार पर, संबंधित परिणाम उत्पन्न होता है। MIME"image/png"() png प्रारूप में एक छवि बनाता है। MIME"image/svg+xml"() एक svg छवि उत्पन्न करता है। हालांकि, दूसरे मामले में, आपको इस तथ्य पर ध्यान देना चाहिए कि पूरी तरह से स्वतंत्र xml-document बनता है, जिसे एक अलग फ़ाइल के रूप में लिखा जा सकता है। उसी समय, हमारा लक्ष्य एक HTML पृष्ठ में एक छवि को एम्बेड करना है, जिसे एचटीएमएल 5 में बस एसवीजी मार्कअप डालकर किया जा सकता है। यही कारण है कि Base.write(file::IO, ::Type{Svg}, p::Plots.Plot) पद्धति Base.write(file::IO, ::Type{Svg}, p::Plots.Plot) xml- हेडर को Base.write(file::IO, ::Type{Svg}, p::Plots.Plot) , जो अन्यथा HTML- दस्तावेज़ की संरचना का उल्लंघन करेगी। हालांकि, अधिकांश ब्राउज़र इस मामले में भी छवि को सही ढंग से प्रदर्शित करने में सक्षम हैं।

Base.write(file::IO, ::Type{Png}, p::Plots.Plot) लिए विधि के बारे में, यहाँ कार्यान्वयन सुविधा यह है कि हम केवल Base.write(file::IO, ::Type{Png}, p::Plots.Plot) प्रारूप में HTML में बाइनरी डेटा सम्मिलित कर सकते हैं। हम इसका उपयोग <img src="data:image/png;base64,"/> निर्माण का उपयोग करके करते हैं। और ट्रांसकोडिंग के लिए हम Base64EncodePipe उपयोग Base64EncodePipe ।

Base.write(file::IO, df::DataFrame) मेथड Base.write(file::IO, df::DataFrame) DataFrame ऑब्जेक्ट के DataFrame टेबल फॉर्मेट में आउटपुट प्रदान करता है।

परिणामी पृष्ठ इस प्रकार है:

छवि में, सभी तीन चित्र लगभग समान दिखते हैं, हालांकि, याद रखें कि उनमें से एक HTML (अतिरिक्त एक्सएमएल-हेडर) के दृष्टिकोण से गलत तरीके से डाला गया है। एक रेखापुंज है, जिसका अर्थ है कि इसे विस्तार के नुकसान के बिना नहीं बढ़ाया जा सकता है। और उनमें से केवल एक HTML मार्कअप के अंदर सही svg टुकड़ा के रूप में डाला जाता है। और यह आसानी से विस्तार के नुकसान के बिना बढ़ाया जा सकता है।

स्वाभाविक रूप से, पृष्ठ बहुत सरल निकला। लेकिन सीएसएस के साथ कोई भी दृश्य वृद्धि संभव है।

रिपोर्ट तैयार करने का यह तरीका उपयोगी है, उदाहरण के लिए, जब प्रदर्शित तालिकाओं की संख्या वास्तविक डेटा द्वारा निर्धारित की जाती है, न कि किसी टेम्पलेट द्वारा। उदाहरण के लिए, आपको कुछ फ़ील्ड द्वारा डेटा को समूहित करने की आवश्यकता है। और प्रत्येक समूह के लिए अलग-अलग ब्लॉक बनाने के लिए। चूंकि पेज बनाते समय, परिणाम Base.write को कॉल की संख्या से निर्धारित होता है, यह स्पष्ट है कि एक लूप में वांछित ब्लॉक को लपेटने में कोई समस्या नहीं है, जिससे आउटपुट डेटा पर निर्भर हो जाता है, आदि।

कोड उदाहरण:

 using DataFrames #       ptable = DataFrame( Symbol = ["H", "He", "C", "O", "Fe" ], Room = [:Gas, :Gas, :Solid, :Gas, :Solid] ) res = groupby(ptable, [:Room]) #      open("out2.html", "w") do f for df in (groupby(ptable, [:Room])) write(f, "<h2>$(df[1, :Room])</h2>\n") show(f, MIME"text/html"(), DataFrame(df)) write(f, "\n") end end

इस स्क्रिप्ट का परिणाम HTML पृष्ठ का एक टुकड़ा है।

कृपया ध्यान दें कि सजावट / प्रारूप रूपांतरण की आवश्यकता नहीं है जो सब कुछ सीधे Base.write फ़ंक्शन के माध्यम से प्रदर्शित होता है। उसी समय, रूपांतरण के लिए आउटपुट की आवश्यकता वाली हर चीज Base.show माध्यम से आउटपुट Base.show ।

Weave.jl

बुन जूलिया द्वारा कार्यान्वित एक वैज्ञानिक रिपोर्ट जनरेटर है। जनरेटर Peaeave, Knitr, rmarkdown, Sweave के विचारों का उपयोग करता है। इसका मुख्य कार्य लैटेक्स, पंडोक, गितुब मार्कडाउन, मल्टीमार्काडाउन, असिसीडोक, रीस्ट्रक्टेक्टेड टैक्स्ट प्रारूपों के लिए प्रस्तावित भाषाओं (नोएब, मार्कडाउन, स्क्रिप्ट प्रारूप) में से किसी में भी स्रोत मार्कअप का निर्यात करना है। और, यहां तक कि IJulia नोटबुक और इसके विपरीत में। उत्तरार्द्ध में, यह जुपाइटेक्स्ट के समान है।

यही है, वीव एक उपकरण है जो आपको विभिन्न मार्कअप भाषाओं में जूलिया-कोड युक्त टेम्पलेट लिखने की अनुमति देता है, और आउटपुट में दूसरी भाषा में मार्कअप है (लेकिन जूलिया-कोड निष्पादन के परिणामों के साथ)। और यह विशेष रूप से शोधकर्ताओं के लिए एक बहुत ही उपयोगी उपकरण है। उदाहरण के लिए, आप लेटेक्स पर एक लेख तैयार कर सकते हैं, जिसमें परिणाम की स्वचालित गणना और इसके प्रतिस्थापन के साथ जूलिया पर आवेषण होंगे। बुनाई अंतिम लेख के लिए एक फ़ाइल उत्पन्न करेगा।

इसी प्लगइन https://atom.io/packages/language-weave का उपयोग करके एटम संपादक के लिए समर्थन है। यह आपको मार्कअप में जूलिया लिपियों को विकसित और डिबग करने की अनुमति देता है, और फिर लक्ष्य फ़ाइल उत्पन्न करता है।

वेव में मूल सिद्धांत, जैसा कि पहले ही उल्लेख किया गया है, पाठ (सूत्र आदि) के साथ मार्कअप युक्त टेम्पलेट को पार्स करना और जूलिया पर कोड पेस्ट करना है। कोड निष्पादन का परिणाम अंतिम रिपोर्ट में प्रदर्शित किया जा सकता है। पाठ का आउटपुट, कोड, परिणामों का आउटपुट, ग्राफ़ का आउटपुट - यह सब व्यक्तिगत रूप से कॉन्फ़िगर किया जा सकता है।

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

ऐसी प्रसंस्करण स्क्रिप्ट का एक उदाहरण:

 #     : # Markdown weave("w_example.jmd", doctype="pandoc" out_path=:pwd) # HTML weave("w_example.jmd", out_path=:pwd, doctype = "md2html") # pdf weave("w_example.jmd", out_path=:pwd, doctype = "md2pdf")

फ़ाइल नामों में jmd जूलिया मार्कडाउन है।

वही उदाहरण लें जो हमने पिछले टूल्स में इस्तेमाल किया था। हालाँकि, हम उस लेखक के बारे में जानकारी के साथ एक शीर्षक डालेंगे जो वीव समझता है।

 --- title : Intro to Weave.jl with Plots author : Anonymous date : 06th Feb 2019 --- # Intro ## Plot ` ``{julia;} using Plots, DataFrames plot(rand(5,5), linewidth=2, title="My Plot", size = (500, 200)) ` `` ## Some computational results ` ``julia rand(2, 3) ` `` ` ``julia DataFrame(rand(2, 3)) ` ``

पीडीएफ में परिवर्तित होने वाला यह टुकड़ा कुछ इस तरह दिखता है:

फ़ॉन्ट्स और लेआउट लेटेक्स उपयोगकर्ताओं द्वारा अच्छी तरह से पहचाने जाते हैं।

एम्बेडेड कोड के प्रत्येक टुकड़े के लिए, आप यह निर्धारित कर सकते हैं कि इस कोड को कैसे संसाधित किया जाएगा और अंत में क्या प्रदर्शित किया जाएगा।

उदाहरण के लिए:

echo = true - कोड प्रदर्शित किया जाएगा
eval = true - कोड निष्पादन का परिणाम प्रदर्शित किया जाएगा
लेबल - एक लेबल जोड़ें। यदि लेटेक्स का उपयोग किया जाता है, तो इसका उपयोग अंजीर: लेबल के रूप में किया जाएगा
अंजीर, छवि आकार
और आगे

अब इस टूल के बारे में अधिक जानकारी के लिए, http://weavejl.mpastell.com/stable/ देखें ।

Literate.jl

इस पैकेज के लेखक, जब पूछा गया कि लिटरेट क्यों, डोनाल्ड नुट्ट के लिटरेट प्रोग्रामिंग पैराडाइम का संदर्भ लें। इस टूल का कार्य जूलिया कोड पर आधारित दस्तावेजों को उत्पन्न करना है जिसमें मार्कडाउन प्रारूप में टिप्पणियां हैं। पिछले बुनाई उपकरण के विपरीत, वह निष्पादन के परिणामों के साथ दस्तावेज़ नहीं बना सकता है। हालाँकि, टूल हल्का है और मुख्य रूप से डॉक्यूमेंटिंग कोड पर केंद्रित है। उदाहरण के लिए, सुंदर उदाहरण लिखने में मदद करें जिन्हें किसी भी मार्कडाउन प्लेटफॉर्म पर रखा जा सकता है। अक्सर अन्य प्रलेखन उपकरणों की एक श्रृंखला में उपयोग किया जाता है, उदाहरण के लिए, Documenter.jl के साथ।

आउटपुट प्रारूप के लिए तीन संभावित विकल्प हैं - मार्कडाउन, नोटबुक और स्क्रिप्ट (शुद्ध जूलिया कोड)। उनमें से कोई भी कार्यान्वित कोड निष्पादित नहीं करेगा।

मार्कडाउन टिप्पणियों के साथ उदाहरण स्रोत फ़ाइल (पहले वर्ण # के बाद):

 #!/usr/bin/env julia using Literate Literate.markdown(@__FILE__, pwd()) # documenter=true # # Intro # ## Plot using Plots, DataFrames plot(rand(5,5), linewidth=2, title="My Plot", size = (500, 200)) # ## Some computational results rand(2, 3) DataFrame(rand(2, 3))

उनके काम का नतीजा Documenter लिए मार्कडाउन डॉक्यूमेंट और निर्देशन होगा, अगर उनकी पीढ़ी स्पष्ट रूप से अक्षम नहीं हुई है।

 ` ``@meta EditURL = "https://github.com/TRAVIS_REPO_SLUG/blob/master/" ` `` ` ``@example literate_example #!/usr/bin/env julia using Literate Literate.markdown(@__FILE__, pwd(), documenter=true) ` `` # Intro ## Plot ` ``@example literate_example using Plots, DataFrames plot(rand(5,5), linewidth=2, title="My Plot", size = (500, 200)) ` `` ## Some computational results ` ``@example literate_example rand(2, 3) DataFrame(rand(2, 3)) ` `` *This page was generated using [Literate.jl](https://github.com/fredrikekre/Literate.jl).*

मार्कडाउन के अंदर कोड डालने को जानबूझकर पहले और बाद के एपोस्ट्रोफ के बीच एक स्थान के साथ रखा जाता है, ताकि लेख प्रकाशित होने पर गड़बड़ न हो।

अधिक विवरण देखें https://fredrikekre.imtqy.com/Literate.jl/stable/

Documenter.jl

प्रलेखन जनरेटर। इसका मुख्य उद्देश्य जूलिया में लिखे पैकेजों के लिए पठनीय दस्तावेज तैयार करना है। डॉक्यूमेंटर html और pdf दोनों उदाहरणों को मार्काडाउन मार्कअप और एम्बेडेड जूलिया कोड, साथ ही मॉड्यूल स्रोत फ़ाइलों के साथ जूलिया-डॉकस्ट्रिंग्स (जूलिया की अपनी टिप्पणियाँ) निकालता है।

विशिष्ट प्रलेखन का एक उदाहरण:

इस लेख में हम दस्तावेज़ीकरण के सिद्धांतों पर ध्यान नहीं देंगे, चूंकि, एक अच्छे तरीके से, यह मॉड्यूल के विकास पर एक अलग लेख के हिस्से के रूप में किया जाना चाहिए। हालाँकि, हम यहाँ वृत्तचित्र के कुछ पहलुओं को देखेंगे।

सबसे पहले, यह इस तथ्य पर ध्यान देने योग्य है कि स्क्रीन दो भागों में विभाजित है - बाईं ओर सामग्री की एक इंटरैक्टिव तालिका है। दाईं ओर, वास्तव में, प्रलेखन का पाठ है।

उदाहरण और प्रलेखन के साथ एक विशिष्ट निर्देशिका संरचना इस प्रकार है:

  docs/ src/ make.jl src/ Example.jl ...

docs/src डायरेक्टरी मार्कडाउन डॉक्यूमेंटेशन है। और उदाहरण कहीं src साझा स्रोत निर्देशिका में पाए जाते हैं।

Docuementer के लिए महत्वपूर्ण फ़ाइल docs/make.jl डॉक्यूमेंटर के लिए इस फाइल की सामग्री:

 using Documenter, DocumenterTools makedocs( modules = [Documenter, DocumenterTools], format = Documenter.HTML( # Use clean URLs, unless built as a "local" build prettyurls = !("local" in ARGS), canonical = "https://juliadocs.imtqy.com/Documenter.jl/stable/", ), clean = false, assets = ["assets/favicon.ico"], sitename = "Documenter.jl", authors = "Michael Hatherly, Morten Piibeleht, and contributors.", analytics = "UA-89508993-1", linkcheck = !("skiplinks" in ARGS), pages = [ "Home" => "index.md", "Manual" => Any[ "Guide" => "man/guide.md", "man/examples.md", "man/syntax.md", "man/doctests.md", "man/latex.md", hide("man/hosting.md", [ "man/hosting/walkthrough.md" ]), "man/other-formats.md", ], "Library" => Any[ "Public" => "lib/public.md", hide("Internals" => "lib/internals.md", Any[ "lib/internals/anchors.md", "lib/internals/builder.md", "lib/internals/cross-references.md", "lib/internals/docchecks.md", "lib/internals/docsystem.md", "lib/internals/doctests.md", "lib/internals/documenter.md", "lib/internals/documentertools.md", "lib/internals/documents.md", "lib/internals/dom.md", "lib/internals/expanders.md", "lib/internals/mdflatten.md", "lib/internals/selectors.md", "lib/internals/textdiff.md", "lib/internals/utilities.md", "lib/internals/writers.md", ]) ], "contributing.md", ], ) deploydocs( repo = "github.com/JuliaDocs/Documenter.jl.git", target = "build", )

जैसा कि आप देख सकते हैं, यहां मुख्य विधियां makedocs और deploydocs , जो भविष्य के प्रलेखन की संरचना और इसके स्थान के लिए जगह निर्धारित करती हैं। makedocs सभी निर्दिष्ट फ़ाइलों से makedocs मार्कअप का निर्माण प्रदान करता है, जिसमें एम्बेडेड कोड का निष्पादन और डॉकिंग टिप्पणियों की निकासी दोनों शामिल हैं।

कोड डालने के लिए दस्तावेजी कई निर्देशों का समर्थन करता है। उनका प्रारूप `` @something

@docs , @autodocs - जूलिया फ़ाइलों से निकाले गए दस्तावेज़ों के लिंक।
@ref , @meta , @index , @contents - लिंक, सूचकांक पृष्ठों के संकेत, आदि।
एम्बेडेड जूलिया कोड के @example , @repl , @eval - निष्पादन मोड।
...

निर्देशों की उपस्थिति @example, @repl, @eval , वास्तव में, निर्धारित करती है कि इस अवलोकन में वृत्तचित्र को शामिल किया जाए या नहीं। इसके अलावा, पहले उल्लिखित Literate.jl स्वचालित रूप से इस तरह के मार्कअप को उत्पन्न कर सकता है, जैसा कि पहले प्रदर्शित किया गया था। यही है, रिपोर्ट जनरेटर के रूप में प्रलेखन जनरेटर के उपयोग पर कोई मौलिक प्रतिबंध नहीं हैं।

Documenter.jl पर अधिक जानकारी के लिए, https://juliadocs.imtqy.com/Documenter.jl/stl/ देखें

निष्कर्ष

जूलिया भाषा के युवाओं के बावजूद, इसके लिए पहले से ही विकसित किए गए पैकेज और उपकरण हमें अत्यधिक भरी हुई सेवाओं में पूर्ण उपयोग के बारे में बात करने की अनुमति देते हैं, न कि केवल परीक्षण परियोजनाओं के कार्यान्वयन के बारे में। जैसा कि आप देख सकते हैं, पाठ और आलेखीय रूप में कोड निष्पादन के परिणामों सहित विभिन्न दस्तावेजों और रिपोर्टों को उत्पन्न करने की क्षमता पहले से ही प्रदान की गई है। इसके अलावा, रिपोर्ट की जटिलता के आधार पर, हम एक टेम्पलेट बनाने में आसानी और रिपोर्ट तैयार करने के लचीलेपन के बीच चयन कर सकते हैं।

लेख Genie.jl पैकेज से फ्लैक्स जनरेटर पर विचार नहीं करता है। जिन्न.जेल पटरियों पर जूलिया को लागू करने का एक प्रयास है, और फ्लैक्स जूलिया के लिए कोड आवेषण के साथ eRubis का एक प्रकार का एनालॉग है। हालांकि, फ्लैक्स को एक अलग पैकेज के रूप में प्रदान नहीं किया गया है, और जिनी को मुख्य पैकेज भंडार में शामिल नहीं किया गया है, इसलिए इसे इस समीक्षा में शामिल नहीं किया गया था।

अलग से, मैं Makie.jl और Luxor.jl पैकेजों का उल्लेख करना चाहूंगा , जो जटिल वेक्टर विज़ुअलाइज़ेशन के गठन प्रदान करते हैं। उनके काम के परिणाम का उपयोग रिपोर्टों के हिस्से के रूप में भी किया जा सकता है, लेकिन इस बारे में एक अलग लेख भी लिखा जाना चाहिए।

जूलिया। रिपोर्ट और दस्तावेज़ जेनरेटर