diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..7e257db --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,3 @@ +{ + "recommendations": [] +} \ No newline at end of file diff --git a/docs/build/.documenter-siteinfo.json b/docs/build/.documenter-siteinfo.json index 7b2b1be..53803c2 100644 --- a/docs/build/.documenter-siteinfo.json +++ b/docs/build/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2024-07-19T18:26:19","documenter_version":"1.5.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2024-07-19T21:50:18","documenter_version":"1.5.0"}} \ No newline at end of file diff --git a/docs/build/index.html b/docs/build/index.html index e2dca65..02b64f8 100644 --- a/docs/build/index.html +++ b/docs/build/index.html @@ -1,2 +1,2 @@ -Home · UCIWWEIHR.jl
GitHub
+HOME · UCIWWEIHR.jl
GitHub
diff --git a/docs/build/news/index.html b/docs/build/news/index.html new file mode 100644 index 0000000..d979d05 --- /dev/null +++ b/docs/build/news/index.html @@ -0,0 +1,2 @@ + +NEWS · UCIWWEIHR.jl
GitHub
diff --git a/docs/build/objects.inv b/docs/build/objects.inv index 2a9d1e8..13af158 100644 Binary files a/docs/build/objects.inv and b/docs/build/objects.inv differ diff --git a/docs/build/search_index.js b/docs/build/search_index.js index 2873cae..658fdb6 100644 --- a/docs/build/search_index.js +++ b/docs/build/search_index.js @@ -1,3 +1,3 @@ var documenterSearchIndex = {"docs": -[{"location":"#UCIWWEIHR.jl","page":"Home","title":"UCIWWEIHR.jl","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"The best summation package.","category":"page"},{"location":"#Package-Features","page":"Home","title":"Package Features","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Sum the squares of two numbers","category":"page"},{"location":"#Function-Documentation","page":"Home","title":"Function Documentation","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"sum_values","category":"page"},{"location":"#UCIWWEIHR.sum_values","page":"Home","title":"UCIWWEIHR.sum_values","text":"sum_values(x,y)\n\nThis is an example of Docstring. This function receives two numbers x and y and returns the sum of the squares.\n\nx^1 + y^1 \n\n\n\n\n\n","category":"function"}] +[{"location":"tutorials/#Tutorials","page":"TUTORIALS","title":"Tutorials","text":"","category":"section"},{"location":"tutorials/","page":"TUTORIALS","title":"TUTORIALS","text":"Welcome to the Tutorials page for the UCIWWEIHR.jl project. This section provides step-by-step guides and examples to help you get started with using the package and understanding its features.","category":"page"},{"location":"tutorials/#Getting-Started","page":"TUTORIALS","title":"Getting Started","text":"","category":"section"},{"location":"tutorials/#Installation","page":"TUTORIALS","title":"Installation","text":"","category":"section"},{"location":"tutorials/","page":"TUTORIALS","title":"TUTORIALS","text":"To install the UCIWWEIHR.jl package, open the Julia REPL and run the following command:","category":"page"},{"location":"tutorials/","page":"TUTORIALS","title":"TUTORIALS","text":"using Pkg\nPkg.add(\"UCIWWEIHR\")","category":"page"},{"location":"news/#Development-Updates","page":"NEWS","title":"Development Updates","text":"","category":"section"},{"location":"news/","page":"NEWS","title":"NEWS","text":"Welcome to the Development Updates page for the UCIWWEIHR.jl project. Here, we will keep track of recent changes, improvements, and notable updates in the development of this project.","category":"page"},{"location":"news/#Recent-Updates","page":"NEWS","title":"Recent Updates","text":"","category":"section"},{"location":"news/#Version-1.0.0-DEV-July-2024","page":"NEWS","title":"Version 1.0.0-DEV - July 2024","text":"","category":"section"},{"location":"news/","page":"NEWS","title":"NEWS","text":"Preparing package for development.","category":"page"},{"location":"news/","page":"NEWS","title":"NEWS","text":"","category":"page"},{"location":"news/","page":"NEWS","title":"NEWS","text":"Last updated: July 19, 2024","category":"page"},{"location":"#UCIWWEIHR.jl","page":"HOME","title":"UCIWWEIHR.jl","text":"","category":"section"},{"location":"","page":"HOME","title":"HOME","text":"The best summation package.","category":"page"},{"location":"#Package-Features","page":"HOME","title":"Package Features","text":"","category":"section"},{"location":"","page":"HOME","title":"HOME","text":"Sum the squares of two numbers","category":"page"},{"location":"#Function-Documentation","page":"HOME","title":"Function Documentation","text":"","category":"section"},{"location":"","page":"HOME","title":"HOME","text":"sum_values","category":"page"},{"location":"#UCIWWEIHR.sum_values","page":"HOME","title":"UCIWWEIHR.sum_values","text":"sum_values(x,y)\n\nThis is an example of Docstring. This function receives two numbers x and y and returns the sum of the squares.\n\nx^1 + y^1 \n\n\n\n\n\n","category":"function"}] } diff --git a/docs/build/tutorials/index.html b/docs/build/tutorials/index.html new file mode 100644 index 0000000..ab780b3 --- /dev/null +++ b/docs/build/tutorials/index.html @@ -0,0 +1,3 @@ + +TUTORIALS · UCIWWEIHR.jl
GitHub

Tutorials

Welcome to the Tutorials page for the UCIWWEIHR.jl project. This section provides step-by-step guides and examples to help you get started with using the package and understanding its features.

Getting Started

Installation

To install the UCIWWEIHR.jl package, open the Julia REPL and run the following command:

using Pkg
+Pkg.add("UCIWWEIHR")
diff --git a/docs/make.jl b/docs/make.jl index 6807b60..7d7abdd 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,17 +1,16 @@ push!(LOAD_PATH,"../src/") -using Pkg -Pkg.add(url="https://github.com/cbernalz/UCIWWEIHR.jl") using UCIWWEIHR using Documenter makedocs( sitename = "UCIWWEIHR.jl", modules = [UCIWWEIHR], - format = Documenter.HTMLFormat(), pages=[ - "HOME" => "index.md" - "TUTORIALS" => "tutorials.md" - "NEWS" => "news.md" - ]) -deploydocs(; - repo="github.com/cbernalz/UCIWWEIHR.jl", + "HOME" => "index.md", + "TUTORIALS" => "tutorials.md", + "NEWS" => "news.md"] +) + +deploydocs( + repo="github.com/cbernalz/UCIWWEIHR.jl.git", + push_preview = true, ) \ No newline at end of file diff --git a/docs/src/index.html b/docs/src/index.html deleted file mode 100644 index 99c4c7d..0000000 --- a/docs/src/index.html +++ /dev/null @@ -1,416 +0,0 @@ - - - - - - - - - - - - - -index - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - -
-

UCIWWEIHR.jl

-

The best summation package.

-
-

Package Features

-
    -
  • Sum the squares of two numbers
    • -
-
-
-

Function Documentation

-
test_functions
-
-
- - - - -
- - - - - - - - - - - - - - -