Cleaning up the directory for package release

azeredo-e · Mar 15, 2024 · 9187997 · 9187997
1 parent a90d57c
commit 9187997
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 11 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,10 +1,12 @@
-#Ignore personal files
-.env
+#Documenter files
+docs/build
+docs/Manifest.toml
+
+#Personal Files
+Manifest.Toml
 
 #Ignore folders
 .vscode/
 releases/
-BCB.py/
 python-bcb/
 project-test/
-
diff --git a/Project.toml b/Project.toml
@@ -21,8 +21,6 @@ julia = "1.9.1"
 
 [extras]
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
-Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 
 [targets]
 test = ["Test"]
-docs = ["Documenter"]
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -0,0 +1,3 @@
+[deps]
+BrazilCentralBank = "1db8e8ca-f8ef-4fae-b3f5-ea2940ece087"
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
diff --git a/docs/make.jl b/docs/make.jl
@@ -1,5 +1,13 @@
 import Dates.AbstractTime
 
-using Documenter, BrazilCentralBank
+using BrazilCentralBank
+using Documenter
 
-makedocs(sitename="BrazilCentralBank")
+DocMeta.setdocmeta!(BrazilCentralBank, :DocTestSetup, :(using BrazilCentralBank); recursive=true)
+
+makedocs(
+    sitename = "BrazilCentralBank.jl",
+    format = Documenter.HTML(),
+    modules = [BrazilCentralBank],
+    checkdocs = :export
+)
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -14,7 +14,7 @@ The final goal is for this to be a comprehensive set of tools for anyone trying
 
 ## Instalation
 
-Source code are avaliable in this project directory, but instalation through Julia's package manager is also avaliable.
+Source code are avaliable in this project directory, but instalation through Julia's package manager will soon be avaliable.
 
 ```julia
 julia> using Pkg; Pkg.add(BrazilCentralBank)
@@ -24,6 +24,6 @@ julia> using Pkg; Pkg.add(BrazilCentralBank)
 
 ```@docs
 BrazilCentralBank
-getcurrency_list()
+getcurrency_list(;convert_to_utf=true)
 gettimeseries(symbols::Union{String, Array}, start::Union{AbstractTime, AbstractString, Number}, finish::Union{AbstractTime, AbstractString, Number}; side::String="side", groupby::String="symbol")
 ```
diff --git a/test/runtests.jl b/test/runtests.jl
@@ -5,7 +5,7 @@ using DataFrames
 using Dates
 using Test
 
-greetBCB()
+BrazilCentralBank.greetBCB()
 
 @testset begin
     @test BrazilCentralBank._get_currency_id("USD") == 61