Docs #43
Docs #43
Conversation
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## develop #43 +/- ##
==========================================
Coverage ? 96.49%
==========================================
Files ? 9
Lines ? 257
Branches ? 0
==========================================
Hits ? 248
Misses ? 9
Partials ? 0 ☔ View full report in Codecov by Sentry. |
Codecov ReportAll modified lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #43 +/- ##
==========================================
Coverage ? 97.07%
==========================================
Files ? 9
Lines ? 308
Branches ? 0
==========================================
Hits ? 299
Misses ? 9
Partials ? 0 ☔ View full report in Codecov by Sentry. |
|
Need to update the URLs in the docs to point to the new repo |
There was a problem hiding this comment.
This looks great @rtimms, few suggestions for changes below
docs/Makefile
Outdated
| # Catch-all target: route all unknown targets to Sphinx using the new | ||
| # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). | ||
| %: Makefile | ||
| @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) |
There was a problem hiding this comment.
running this makefile gave me an error:
Makefile:19: *** missing separator. Stop.
Could be that your using spaces instead of tabs
https://stackoverflow.com/questions/920413/make-error-missing-separator
There was a problem hiding this comment.
I actually just copied this from PyBaMM haha, and you get the same error there, but the docs seem to build ok?
There was a problem hiding this comment.
yea, docs build ok if you manually call sphinx-build (which is the command in the readme), but the Makefile doesn't work. You could either just delete the Makefile or fix it, up to you.
There was a problem hiding this comment.
probably same over in pybamm if you copied it from there :)
There was a problem hiding this comment.
looks good @rtimms, just the Makefile to deal with, but this is optional (either delete it as unneeded or fix the tabs/spaces thing)
Add docs and update README. At the moment, docs must be built locally.