24 lines
8.5 KiB
HTML
24 lines
8.5 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Génération de la documentation d'un dépot git · Optinum.jl</title><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.11.1/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="index.html"><img src="assets/logo.png" alt="Optinum.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit">Optinum.jl</span></div><form class="docs-search" action="search.html"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="index.html">Accueil</a></li><li><a class="tocitem" href="Sujet.html">Sujet</a></li><li><span class="tocitem">Algorithmes</span><ul><li><a class="tocitem" href="Algorithme_de_newton.html">L'algorithme de Newton local</a></li><li><a class="tocitem" href="Regions_de_confiance.html">La méthode des régions de confiance</a></li><li><a class="tocitem" href="Lagrangien_augmente.html">La méthode du Lagrangien augmenté</a></li></ul></li><li><a class="tocitem" href="fct_index.html">Index des fonctions</a></li><li><a class="tocitem" href="Annexes.html">Annexes</a></li><li><a class="tocitem" href="mise_en_place.html">Installation de Julia et tests unitaires</a></li><li><a class="tocitem" href="FAQ.html">Foire aux Questions</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href="generation_doc.html">Génération de la documentation d'un dépot git</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="generation_doc.html">Génération de la documentation d'un dépot git</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com//blob/master/docs/src/generation_doc.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="Génération-de-la-documentation-d'un-dépot-git-1"><a class="docs-heading-anchor" href="#Génération-de-la-documentation-d'un-dépot-git-1">Génération de la documentation d'un dépot git</a><a class="docs-heading-anchor-permalink" href="#Génération-de-la-documentation-d'un-dépot-git-1" title="Permalink"></a></h1><h3 id="/-Créer-un-répertoire-docs/-au-niveau-de-la-racine-du-projet-1"><a class="docs-heading-anchor" href="#/-Créer-un-répertoire-docs/-au-niveau-de-la-racine-du-projet-1">1/ Créer un répertoire <code>docs/</code> au niveau de la racine du projet</a><a class="docs-heading-anchor-permalink" href="#/-Créer-un-répertoire-docs/-au-niveau-de-la-racine-du-projet-1" title="Permalink"></a></h3><h3 id="/-En-se-plaçant-au-niveau-du-répertoire-docs/-1"><a class="docs-heading-anchor" href="#/-En-se-plaçant-au-niveau-du-répertoire-docs/-1">2/ En se plaçant au niveau du répertoire <code>docs/</code></a><a class="docs-heading-anchor-permalink" href="#/-En-se-plaçant-au-niveau-du-répertoire-docs/-1" title="Permalink"></a></h3><h3 id="1/-Création-du-fichier-make.jl-1"><a class="docs-heading-anchor" href="#1/-Création-du-fichier-make.jl-1">2-1/ Création du fichier <code>make.jl</code></a><a class="docs-heading-anchor-permalink" href="#1/-Création-du-fichier-make.jl-1" title="Permalink"></a></h3><p>Ce programme utilise <code>Documenter.makedocs()</code> pour générer les pages html et <code>Documenter.deploydocs()</code> pour la dépoloyer dans les Github-pages:</p><pre><code class="language-julia">using Documenter
|
|
using *le module*
|
|
|
|
makedocs(
|
|
modules = [*le module*],
|
|
sitename = "le nom du site",
|
|
authors = "author 1, author 2, ...",
|
|
format = Documenter.HTML(prettyurls = get(ENV, "CI", nothing) == "true"),
|
|
pages = [
|
|
*Ici vous listez vos pages de la façon suivante*
|
|
"Le nom de la page 1 " => "page1.md",
|
|
"Le nom de la page 2 " => "page2.md",
|
|
.
|
|
.
|
|
.
|
|
]
|
|
)
|
|
|
|
deploydocs(repo = "*Le lien du dépôt git*")</code></pre><h3 id="2/-Ajouter-les-dépendances-spécifiques-à-la-génération-de-la-doc-1"><a class="docs-heading-anchor" href="#2/-Ajouter-les-dépendances-spécifiques-à-la-génération-de-la-doc-1">2-2/- Ajouter les dépendances spécifiques à la génération de la doc</a><a class="docs-heading-anchor-permalink" href="#2/-Ajouter-les-dépendances-spécifiques-à-la-génération-de-la-doc-1" title="Permalink"></a></h3><p>Au niveau du répertoire <em>docs</em> vous tapez sur un terminal</p><pre><code class="language-linux">/docs$ julia</code></pre><pre><code class="language-Julia">julia> ]
|
|
pkg> activate .
|
|
(docs) pkg> add Documenter
|
|
(docs) pkg> add *Le lien git du module*</code></pre><h3 id="3/-ajout-des-fichiers-1"><a class="docs-heading-anchor" href="#3/-ajout-des-fichiers-1">2-3/ ajout des fichiers</a><a class="docs-heading-anchor-permalink" href="#3/-ajout-des-fichiers-1" title="Permalink"></a></h3><p>Créez un docs <code>src/</code> ensuite <code>src/assets/</code> le premier contiendra <code>les fichiers.md</code> et le deuxième contiendra les éventuels images, logo et autres. (pour ajouter un logo mettez l'image sous le nom <code>logo.<extension></code> dans <code>assets/</code>.</p><h3 id="4/-index-des-fonctions-1"><a class="docs-heading-anchor" href="#4/-index-des-fonctions-1">2-4/ index des fonctions</a><a class="docs-heading-anchor-permalink" href="#4/-index-des-fonctions-1" title="Permalink"></a></h3><pre><code class="language-julia"></code></pre><h3 id="/-Génération-de-la-docs-1"><a class="docs-heading-anchor" href="#/-Génération-de-la-docs-1">3/- Génération de la docs</a><a class="docs-heading-anchor-permalink" href="#/-Génération-de-la-docs-1" title="Permalink"></a></h3><p>Pour en savoir plus, consultez <a href="https://juliadocs.github.io/Documenter.jl/stable/lib/public/#Documenter">cette page</a>. </p></article></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <span class="colophon-date" title="Monday 8 November 2021 11:31">Monday 8 November 2021</span>. Using Julia version 1.4.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
|