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

Setup Documenter #12

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Setup Documenter #12

wants to merge 1 commit into from

Conversation

ahojukka5
Copy link
Member

Closes issue #10.

@ahojukka5 ahojukka5 requested a review from jw3126 July 24, 2018 07:00
docs/make.jl Outdated
format = :html,
checkdocs = :all,
sitename = "BoundingSphere.jl",
authors = "Jukka Aho",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should probably be more people.

@coveralls
Copy link

coveralls commented Jul 24, 2018

Pull Request Test Coverage Report for Build 39

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 3 unchanged lines in 2 files lost coverage.
  • Overall coverage remained the same at 100.0%

Files with Coverage Reduction New Missed Lines %
src/util.jl 1 50.0%
src/geometry.jl 2 71.43%
Totals Coverage Status
Change from base Build 37: 0.0%
Covered Lines: 118
Relevant Lines: 118

💛 - Coveralls

Copy link
Collaborator

@jw3126 jw3126 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could add api.md containing

## Docstrings

```@autodocs
Modules = [BoundingSphere]
```

@ahojukka5
Copy link
Member Author

Hmm still failing for 0.7

Closes issue #10.
@ahojukka5
Copy link
Member Author

It looks that PkgTestSuite is going to be deprecated at the end of Julia 0.6 as it doesn't work anymore in 0.7 (see discussion). For 0.7 we need to change a strategy.

@jw3126
Copy link
Collaborator

jw3126 commented Jul 27, 2018

Okay! I would prefer to have an initial release soon and not wait for the successor of PkgTestSuite. So maybe just use the default .travis file? Also I think Documenter is nice to have, but not necessary if too much hassle to setup by hand. The package is so small, that the README.md alone can do the job.

@TeroFrondelius
Copy link
Member

I agree. The first version doesn't need to be perfect. Then again is there much to do to make it perfect? Sorry that I haven't contributed even though I promised to fix the licences for each file.

@jw3126
Copy link
Collaborator

jw3126 commented Jul 27, 2018

Last time I set up Documenter it took me several hours, but I guess if you know what you are doing it might be 10 minutes instead 😄

@ahojukka5
Copy link
Member Author

There's nothing wrong with the Documenter setup, it's already done. The problem is with PkgTestSuite, which refuses to work with 0.7. I fix the package so that it doesn't use that and then we have tests passing also for 0.7.

@TeroFrondelius
Copy link
Member

@ahojukka5 include fixing this to your documentation project.

@TeroFrondelius TeroFrondelius mentioned this pull request Oct 10, 2019
@ahojukka5 ahojukka5 added this to In progress in Improve documentation of JuliaFEM via automation Oct 10, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

None yet

4 participants