fsprojects / ExcelFinancialFunctions

.NET Standard library providing the full set of financial functions from Excel.
https://fsprojects.github.io/ExcelFinancialFunctions
Other
195 stars 66 forks source link

Move to modern fsdocs tool #46

Closed nhirschey closed 2 years ago

nhirschey commented 2 years ago

Hi @jcoliz, thanks for updating this to netstandard2.0! I was watching this because I wanted to use it this spring on net6.0.

This pull request is all about updating the documentation tool and facilitating automatic docs deployment via github actions. the changes were:

  1. Move release notes out of docs folder so that it doesn't get turned into a page on the docs website. If you wanted it on the docs website, sorry! it could be moved back.
  2. update to use new fsdocs tool.
  3. split into a two workflows so that docs are only deployed on pushes to the master (for example, like what Don Syme and Phillip Carter use on FSharp.Data).
  4. Given that the old library had a githup pages set up, my guess is that on merging this PR to master this will redeploy the documentation site that is currently showing 404.

To see docs locally, do

dotnet tool restore
dotnet build --configuration=Release
dotnet fsdocs watch 

Closes #16

jcoliz commented 2 years ago

That's fantastic, thanks @nhirschey. Good thing, because I have no idea how the doc build system worked. I will spend some time with the PR to understand it all.

jcoliz commented 2 years ago

Awesome, thanks again for this Nicholas. It will be great to have a working docs page. I've run it, and I have a few questions to ask...

sergey-tihon commented 2 years ago

GITHUB_TOKEN just available for you automatically inside GitHub Actions.

nhirschey commented 2 years ago
  1. See Sergey's above comment about the github token.
  2. Fixed the license path in latest commit.
  3. The docs from wrapperdotnettype.fs are in the Excel.FinancialFunctions.Financial type.

image

jcoliz commented 2 years ago

Ok, thanks for the above. @sergey-tihon, appreciate the education on github token. I will have to think some more about the namespaces here, because having the many API at the same level as a random enum seems subpar for discoverability. Also, do you know how we can fix the [learn more] links in the screenshot above? It would seem that the intent is for them to be clickable links in the docs.

Anyway, nice work. Merging now. Also fixes #47

nhirschey commented 2 years ago

You could fix the [learn more] links by adding to the project file. See here. But the links in visual studio tooltips still won’t be fixed.

It would probably be better to convert them to the standard XML href links described in fsharp formatting api docs so that it works on the web and in tooltips.