-
Notifications
You must be signed in to change notification settings - Fork 12
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
Documentation Update and Changes for v2 release #459
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #459 +/- ##
==========================================
+ Coverage 53.59% 55.24% +1.65%
==========================================
Files 144 144
Lines 22364 22560 +196
==========================================
+ Hits 11986 12464 +478
+ Misses 10378 10096 -282 ☔ View full report in Codecov by Sentry. |
…but commonly misunderstood
d4df5ec
to
6122216
Compare
I built the docs locally and found some display issues in the browser. I submitted a commit to fix the format issues. |
I've gone through this as much I can locally. I've gotten rid of all the errors sphynx running in with the dev container detects that i think are correct. There are some residual errors I think are related to doxygen documents that are not being created with the make operation I am running. It would be really good to get this installed. This update to the documentation is released we should soon do our v2.0 release. WARNING: this branch should ONLY change files in the docs directory. It was forked from master months ago and there could be merge issues from that. |
I see the test are failing. Case in point that the merge needs to be done with care. |
Changes in this branch are completely limited to the docs directory. The changes are, however, extensive.
Because of item 3 this branch should NOT be merged until the related changes in the cleanup_database branch are merged. Otherwise our online documentation will be out of sync with the code base.
I also have a few more FAQ pages I want to finish writing that have not yet been pushed. I'm starting this pull request now so fellow development team members can comment and edit out any typos and confusing/inaccurate statements. @wangyinz , could you, in particular, run this through sphynx to check for any glaring format errors? I have not been able to get sphynx to run on this laptop that I've been using for working on these documentation pages.