Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding Documenter.jl documentation #91

Closed
wants to merge 2 commits into from

Conversation

AnHeuermann
Copy link
Member

@arun3688 I translated most of the User's Guide documentation into a OMJulia documentation using Documenter.jl.

It's still rough and a lot of functions are not using the "Julia style" of documentation, see https://docs.julialang.org/en/v1/manual/documentation/.

Also many examples are broken (maybe the User's guide was outdated or the function was never used).

Can you update the docstrings of the modelicaSystem functions?

To build and host locally:

using Pkg; Pkg.activate("docs/"); Pkg.resolve()
using OMJulia, LiveServer
servedocs()

@AnHeuermann AnHeuermann self-assigned this Aug 29, 2023
@arun3688
Copy link
Contributor

@AnHeuermann Yes i will update the docstring soon

@AnHeuermann
Copy link
Member Author

Then I'll suggest that I'll push this to a new-doc branch on this repository and we updated the doc until we are happy and then merge it into the master branch. Then we can test the GitHub page hosting as well.

@arun3688
Copy link
Contributor

Then I'll suggest that I'll push this to a new-doc branch on this repository and we updated the doc until we are happy and then merge it into the master branch. Then we can test the GitHub page hosting as well.

perfect, I am doing some fixes for Linearization in OMPython today, I will finish it by today and then work on the documentation

@AnHeuermann
Copy link
Member Author

Closing in favor of #92.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants