-
Notifications
You must be signed in to change notification settings - Fork 57
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
Docs structure #250
Docs structure #250
Conversation
source/_build/.buildinfo
Outdated
@@ -0,0 +1,4 @@ | |||
# Sphinx build info version 1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think the _build
folder should be added to git (in the same way that the contents of documentation
is currently not
Thank you so much for looking at this! I've made a couple of suggestions but, in answer to your main point, in general we'd like the sphinx documentation to look much like our current doxygen-based documentation. Things to consider are:
|
I also spotted https://github.com/vovkos/doxyrest which might be worth trying as an alternative to breathe |
Hi, as you suggested, I used And regarding the |
Ok, after a lot of fiddling with readthedocs/Jenkins, this is now basically working on the readthedocs2 branch (the best thing may be to update your fork and work from there). Outstanding things that need investigating are:
|
Oh! I didn't get a notification at all. I randomly surfed through here to check the updates on |
No worries, github notifications can be a bit flaky at times! |
Codecov Report
@@ Coverage Diff @@
## master #250 +/- ##
==========================================
- Coverage 87.64% 86.92% -0.73%
==========================================
Files 62 121 +59
Lines 8363 23474 +15111
==========================================
+ Hits 7330 20405 +13075
- Misses 1033 3069 +2036
Continue to review full report at Codecov.
|
Hi @neworderofjamie , I just added a basic minimal structure with
sphinx
(insource
directory) usingBreathe
extension to get theDoxygen
generatedXML
files (currently indocumentation/xml/
). In a nutshell,doxygen/genn-doxygen.conf
file to generateXML
(lineGENERATE_XML = YES
).XML
files are stored indocumentation/xml
.Sphinx
source directory, usingsphinx-quickstart
.source/conf.py
file to addBreathe
extension and added path ofdoxygen
generatedXML
files.index.rst
to adddoxygenclass
etc. (which needs to be done with some discussions).Sphinx
build to generatehtml
files (Saved inSource/_build
)Kindly have a look and as a newbie to
GeNN
, I am not certain about arrangingindex.rst
file entities fromXML
files to determine how the final doc should look like. So I need your support here to finish this successfully.fixes #230