From 5a732c7a2c605d8097ba24a92f960bea29970b5c Mon Sep 17 00:00:00 2001 From: gergaud Date: Wed, 14 Oct 2020 10:14:44 +0200 Subject: [PATCH] tranfert de la doc du OptinumProf vers Optinum --- Manifest.toml | 128 +++++++++++++++++----------------------------- Project.toml | 1 + docs/make.jl | 33 ++++++++++-- docs/src/index.md | 8 +-- 4 files changed, 83 insertions(+), 87 deletions(-) diff --git a/Manifest.toml b/Manifest.toml index c4ed6d3..7748265 100644 --- a/Manifest.toml +++ b/Manifest.toml @@ -1,11 +1,5 @@ # This file is machine-generated - editing it directly is not advised -[[Adapt]] -deps = ["LinearAlgebra"] -git-tree-sha1 = "0fac443759fa829ed8066db6cf1077d888bb6573" -uuid = "79e6a3ab-5dfb-504d-930d-738a2a938a0e" -version = "2.0.2" - [[Base64]] uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f" @@ -23,21 +17,21 @@ version = "3.9.0" [[ColorTypes]] deps = ["FixedPointNumbers", "Random"] -git-tree-sha1 = "efec1b9e082d98d24c99f243abafb4653fb960d6" +git-tree-sha1 = "27eb374570946a02aa184ef5b403dabaa7380693" uuid = "3da002f7-5984-5a60-b8a6-cbb66c0b333f" -version = "0.10.7" +version = "0.10.4" [[Colors]] deps = ["ColorTypes", "FixedPointNumbers", "InteractiveUtils", "Reexport"] -git-tree-sha1 = "5639e44833cfcf78c6a73fbceb4da75611d312cd" +git-tree-sha1 = "1e9bba7984e78aa8cdeea7f9f7cc984ad4e4b1c7" uuid = "5ae59095-9a9b-59fe-a467-6f913c188581" -version = "0.12.3" +version = "0.12.2" [[Contour]] deps = ["StaticArrays"] -git-tree-sha1 = "81685fee51fc5168898e3cbd8b0f01506cd9148e" +git-tree-sha1 = "0b17db36e7e03f8437e0d1f55aea3e4a60c74353" uuid = "d38c429a-6771-53c6-b99e-75d170b6e991" -version = "0.5.4" +version = "0.5.3" [[DataAPI]] git-tree-sha1 = "176e23402d80e7743fc26c19c681bfb11246af32" @@ -46,14 +40,9 @@ version = "1.3.0" [[DataStructures]] deps = ["InteractiveUtils", "OrderedCollections"] -git-tree-sha1 = "edad9434967fdc0a2631a65d902228400642120c" +git-tree-sha1 = "be680f1ad03c0a03796aa3fda5a2180df7f83b46" uuid = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8" -version = "0.17.19" - -[[DataValueInterfaces]] -git-tree-sha1 = "bfc1187b79289637fa0ef6d4436ebdfe6905cbd6" -uuid = "e2d170a0-9d28-54be-80f0-106bbe20a464" -version = "1.0.0" +version = "0.17.18" [[Dates]] deps = ["Printf"] @@ -67,6 +56,18 @@ uuid = "8bb1440f-4735-579b-a4ab-409b98df4dab" deps = ["Random", "Serialization", "Sockets"] uuid = "8ba89e20-285c-5b6f-9357-94700520ee1b" +[[DocStringExtensions]] +deps = ["LibGit2", "Markdown", "Pkg", "Test"] +git-tree-sha1 = "c5714d9bcdba66389612dc4c47ed827c64112997" +uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae" +version = "0.8.2" + +[[Documenter]] +deps = ["Base64", "Dates", "DocStringExtensions", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Test", "Unicode"] +git-tree-sha1 = "395fa1554c69735802bba37d9e7d9586fd44326c" +uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4" +version = "0.24.11" + [[FFMPEG]] deps = ["FFMPEG_jll"] git-tree-sha1 = "c82bef6fc01e30d500f588cd01d29bdd44f1924e" @@ -80,10 +81,9 @@ uuid = "b22a6f82-2f65-5046-a5b2-351ab43fb4e5" version = "4.1.0+3" [[FixedPointNumbers]] -deps = ["Statistics"] -git-tree-sha1 = "335bfdceacc84c5cdf16aadc768aa5ddfc5383cc" +git-tree-sha1 = "8fb797c37a3b7ced4327a05ac4ca0dd6a4f1ba92" uuid = "53c48c17-4a7d-5ca2-90c5-79b7896eea93" -version = "0.8.4" +version = "0.8.1" [[FreeType2_jll]] deps = ["Bzip2_jll", "Libdl", "Pkg", "Zlib_jll"] @@ -99,15 +99,9 @@ version = "1.0.5+3" [[GR]] deps = ["Base64", "DelimitedFiles", "HTTP", "JSON", "LinearAlgebra", "Printf", "Random", "Serialization", "Sockets", "Test", "UUIDs"] -git-tree-sha1 = "e26c513329675092535de20cc4bb9c579c8f85a0" +git-tree-sha1 = "247adbd2b33c0c4b42efa20d1e807acf6312145f" uuid = "28b8d3ca-fb5f-59d9-8090-bfdbd6d07a71" -version = "0.51.0" - -[[GeometryBasics]] -deps = ["IterTools", "LinearAlgebra", "StaticArrays", "StructArrays", "Tables"] -git-tree-sha1 = "119f32f9c2b497b49cd3f7f513b358b82660294c" -uuid = "5c1252a2-5f33-56bf-86c9-59e7332b4326" -version = "0.2.15" +version = "0.50.1" [[GeometryTypes]] deps = ["ColorTypes", "FixedPointNumbers", "LinearAlgebra", "StaticArrays"] @@ -117,9 +111,9 @@ version = "0.8.3" [[HTTP]] deps = ["Base64", "Dates", "IniFile", "MbedTLS", "Sockets"] -git-tree-sha1 = "eca61b35cdd8cd2fcc5eec1eda766424a995b02f" +git-tree-sha1 = "ec87d5e2acbe1693789efbbe14f5ea7525758f71" uuid = "cd3eb016-35fb-5094-929b-558a96fad6f3" -version = "0.8.16" +version = "0.8.15" [[IniFile]] deps = ["Test"] @@ -131,16 +125,6 @@ version = "0.5.0" deps = ["Markdown"] uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240" -[[IterTools]] -git-tree-sha1 = "05110a2ab1fc5f932622ffea2a003221f4782c18" -uuid = "c8e1da08-722c-5040-9ed9-7db0dc04731e" -version = "1.3.0" - -[[IteratorInterfaceExtensions]] -git-tree-sha1 = "a3f24677c21f5bbe9d2a714f95dcd58337fb2856" -uuid = "82899510-4779-5014-852e-03e436cf321d" -version = "1.0.0" - [[JSON]] deps = ["Dates", "Mmap", "Parsers", "Unicode"] git-tree-sha1 = "b34d7cef7b337321e97d22242c3c2b91f476748e" @@ -185,9 +169,9 @@ version = "1.0.2" [[MbedTLS_jll]] deps = ["Libdl", "Pkg"] -git-tree-sha1 = "a0cb0d489819fa7ea5f9fa84c7e7eba19d8073af" +git-tree-sha1 = "c83f5a1d038f034ad0549f9ee4d5fac3fb429e33" uuid = "c8ffd9c3-330d-5841-b78e-0817d7145fa1" -version = "2.16.6+1" +version = "2.16.0+2" [[Measures]] git-tree-sha1 = "e498ddeee6f9fdb4551ce855a46f54dbd900245f" @@ -204,9 +188,9 @@ version = "0.4.3" uuid = "a63ad114-7e13-5084-954f-fe012c677804" [[NaNMath]] -git-tree-sha1 = "c84c576296d0e2fbb3fc134d3e09086b3ea617cd" +git-tree-sha1 = "928b8ca9b2791081dc71a51c55347c27c618760f" uuid = "77ba4419-2d1f-58cd-9bb1-8ffee604a2e3" -version = "0.3.4" +version = "0.3.3" [[Ogg_jll]] deps = ["Libdl", "Pkg"] @@ -216,9 +200,9 @@ version = "1.3.4+0" [[OpenSSL_jll]] deps = ["Libdl", "Pkg"] -git-tree-sha1 = "7aaaded15bf393b5f34c2aad5b765c18d26cb495" +git-tree-sha1 = "d2a6f25262d568b5a7e454cf7ff5066a79d16c7d" uuid = "458c3c95-2e84-50aa-8efc-19380b2a3a95" -version = "1.1.1+4" +version = "1.1.1+2" [[Opus_jll]] deps = ["Libdl", "Pkg"] @@ -227,15 +211,15 @@ uuid = "91d4177d-7536-5919-b921-800302f37372" version = "1.3.1+1" [[OrderedCollections]] -git-tree-sha1 = "293b70ac1780f9584c89268a6e2a560d938a7065" +git-tree-sha1 = "12ce190210d278e12644bcadf5b21cbdcf225cd3" uuid = "bac558e1-5e72-5ebc-8fee-abe8a469f55d" -version = "1.3.0" +version = "1.2.0" [[Parsers]] deps = ["Dates", "Test"] -git-tree-sha1 = "10134f2ee0b1978ae7752c41306e131a684e1f06" +git-tree-sha1 = "eb3e09940c0d7ae01b01d9291ebad7b081c844d3" uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0" -version = "1.0.7" +version = "1.0.5" [[Pkg]] deps = ["Dates", "LibGit2", "Libdl", "Logging", "Markdown", "Printf", "REPL", "Random", "SHA", "UUIDs"] @@ -254,10 +238,10 @@ uuid = "995b91a9-d308-5afd-9ec6-746e21dbc043" version = "1.0.5" [[Plots]] -deps = ["Base64", "Contour", "Dates", "FFMPEG", "FixedPointNumbers", "GR", "GeometryBasics", "GeometryTypes", "JSON", "LinearAlgebra", "Measures", "NaNMath", "PlotThemes", "PlotUtils", "Printf", "REPL", "Random", "RecipesBase", "RecipesPipeline", "Reexport", "Requires", "Showoff", "SparseArrays", "Statistics", "StatsBase", "UUIDs"] -git-tree-sha1 = "b5b2502c96b93be9373990798ddb7b6c0da0d9f6" +deps = ["Base64", "Contour", "Dates", "FFMPEG", "FixedPointNumbers", "GR", "GeometryTypes", "JSON", "LinearAlgebra", "Measures", "NaNMath", "PlotThemes", "PlotUtils", "Printf", "REPL", "Random", "RecipesBase", "RecipesPipeline", "Reexport", "Requires", "Showoff", "SparseArrays", "Statistics", "StatsBase", "UUIDs"] +git-tree-sha1 = "70908194bb636437f181683625925505fd1664a8" uuid = "91a5bcdd-55d7-5caf-9e0b-520d859cae80" -version = "1.5.6" +version = "1.4.1" [[Printf]] deps = ["Unicode"] @@ -272,15 +256,15 @@ deps = ["Serialization"] uuid = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c" [[RecipesBase]] -git-tree-sha1 = "58de8f7e33b7fda6ee39eff65169cd1e19d0c107" +git-tree-sha1 = "54f8ceb165a0f6d083f0d12cb4996f5367c6edbc" uuid = "3cdcf5f2-1ef4-517c-9805-6587b60abb01" -version = "1.0.2" +version = "1.0.1" [[RecipesPipeline]] deps = ["Dates", "PlotUtils", "RecipesBase"] -git-tree-sha1 = "d2a58b8291d1c0abae6a91489973f8a92bf5c04a" +git-tree-sha1 = "9477d23b9ded11153622d8619d0c20c4626a4ac8" uuid = "01d81517-befc-4cb6-b9ec-a95719d0359c" -version = "0.1.11" +version = "0.1.10" [[Reexport]] deps = ["Pkg"] @@ -321,9 +305,9 @@ uuid = "2f01184e-e22b-5df5-ae63-d93ebab69eaf" [[StaticArrays]] deps = ["LinearAlgebra", "Random", "Statistics"] -git-tree-sha1 = "016d1e1a00fabc556473b07161da3d39726ded35" +git-tree-sha1 = "5c06c0aeb81bef54aed4b3f446847905eb6cbda0" uuid = "90137ffa-7385-5640-81b9-e52037218182" -version = "0.12.4" +version = "0.12.3" [[Statistics]] deps = ["LinearAlgebra", "SparseArrays"] @@ -335,24 +319,6 @@ git-tree-sha1 = "a6102b1f364befdb05746f386b67c6b7e3262c45" uuid = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91" version = "0.33.0" -[[StructArrays]] -deps = ["Adapt", "DataAPI", "Tables"] -git-tree-sha1 = "8099ed9fb90b6e754d6ba8c6ed8670f010eadca0" -uuid = "09ab397b-f2b6-538f-b94a-2f83cf4a842a" -version = "0.4.4" - -[[TableTraits]] -deps = ["IteratorInterfaceExtensions"] -git-tree-sha1 = "b1ad568ba658d8cbb3b892ed5380a6f3e781a81e" -uuid = "3783bdb8-4a98-5b6b-af9a-565f29a5fe9c" -version = "1.0.0" - -[[Tables]] -deps = ["DataAPI", "DataValueInterfaces", "IteratorInterfaceExtensions", "LinearAlgebra", "TableTraits", "Test"] -git-tree-sha1 = "c45dcc27331febabc20d86cb3974ef095257dcf3" -uuid = "bd369af6-aec1-5ad0-b16a-f7cc5008161c" -version = "1.0.4" - [[Test]] deps = ["Distributed", "InteractiveUtils", "Logging", "Random"] uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40" @@ -374,9 +340,9 @@ uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5" [[Zlib_jll]] deps = ["Libdl", "Pkg"] -git-tree-sha1 = "622d8b6dc0c7e8029f17127703de9819134d1b71" +git-tree-sha1 = "a2e0d558f6031002e380a90613b199e37a8565bf" uuid = "83775a58-1f1d-513f-b197-d71354ab007a" -version = "1.2.11+14" +version = "1.2.11+10" [[libass_jll]] deps = ["Bzip2_jll", "FreeType2_jll", "FriBidi_jll", "Libdl", "Pkg", "Zlib_jll"] diff --git a/Project.toml b/Project.toml index 595525a..37b21a3 100644 --- a/Project.toml +++ b/Project.toml @@ -4,6 +4,7 @@ authors = ["relmo "] version = "0.1.0" [deps] +Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" GR = "28b8d3ca-fb5f-59d9-8090-bfdbd6d07a71" LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e" Markdown = "d6f4376e-aef5-505a-96c1-9c027394607a" diff --git a/docs/make.jl b/docs/make.jl index 269ec91..d712adc 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,13 +1,40 @@ using Documenter using Optinum -makedocs( + +makedocs( modules = [Optinum], sitename = "Optinum.jl", + strict=true, authors = "Saloua Naama, Mohamed El Waghf et Rachid ELMontassir", format = Documenter.HTML(prettyurls = get(ENV, "CI", nothing) == "true"), pages = [ - "Accueil" => "index.md" + "Accueil" => "index.md", + "Sujet" => "Sujet.md", + "Algorithmes" => [ + "L'algorithme de Newton local" => "Algorithme_de_newton.md", + "La méthode des régions de confiance" => "Regions_de_confiance.md", + "La méthode du Lagrangien augmenté" => "Lagrangien_augmente.md" + ], + "Index des fonctions" =>"fct_index.md", + "Travail à réaliser" => [ + "Pour l'algorithme de Newton" => "Questions_Newton.md", + "Pour les régions de confiance avec le pas de Cauchy" => "Questions_Pas_De_Cauchy.md", + "Pour les régions de confiance avec le gradient conjugué tronqué" => "Questions_GCT.md", + "Pour Lagrangien augmenté" => "Questions_Lagrangien_Augmente.md" + ], + "Annexes" => "Annexes.md", + "Exemples d'appels" =>"Exemples.md", + "Mise en place" => "mise_en_place.md", + "Julia vs MatLab"=> "julia_vs_matlab.md", + "Création de Modules en Julia" => "create_package.md", + "Création d'un dépôt Git pour un module Julia" => "git_doc.md", + "Géneration de la doc" => "generation_doc.md", + "Intégration continue et déploiement de la Doc avec Travis" =>"Integration_continue.md", + "Précompilation des modules"=>"Precompilation.md", + "Génération du rapport" => "generate_pdf.md", + "Foire aux Questions" =>"FAQ.md" + ] ) @@ -15,4 +42,4 @@ deploydocs( repo = "github.com/mathn7/Optinum.git", branch = "gh-pages", devbranch = "master", -) \ No newline at end of file +) diff --git a/docs/src/index.md b/docs/src/index.md index b5e57e3..3f41454 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,5 +1,7 @@ -# Optinum - Méthodes numériques pour les problèmes d’optimisation +# OptinumProf - Méthodes numériques pour les problèmes d’optimisation -Le package [Optinum](https://github.com/mathn7/Optinum) est le sujet du TP-projet d’Optimisation Numérique pour l’année 2020-2021 de l'École INP-ENSEEIHT, et contient les algorithmes vus en cours. +Le package [OptinumProf](https://github.com/mathn7/OptinumProf) constitue une +solution du projet d’Optimisation Numérique pour l’année 2020-2021 de l'École INP-ENSEEIHT, +et contient tous les algorithmes vus en cours. -###### Auteurs : O.Cots, J. Gergaud, S. Gratton, P. Matalon, C. Royer, D. Ruiz et E. Simon +###### Auteurs : O.Cots, J. Gergaud, S. Gratton, P. Matalon, C. Royer, D. Ruiz et E. Simon \ No newline at end of file