feat: Adds firmware content to documentation #48
Conversation
There was a problem hiding this comment.
The objects.inv file should really be generated in the human-readable format, otherwise we're version controlling a file which is just a binary blob, and that's a bit silly (plus it bloats the history). Apparently it's possible to generate this file, you just need to use intersphinx. I'm not sure how you've set this up so I can't remark further, but unless you're really sure we should be committing this file as-is I think we should try to fix this.
|
@drspangle just followed the instructions written in pull request #47 which is just the default in the sphinx documentation. Not sure what the .inv file is for, would you like it to be added to the .gitignore file? Not sure what is |
|
I think this is no longer necessary anymore. |
|
Oops, I mistook this for something else. I guess this is still useful, but it doesn't conform to the updated documentation anymore, so it might need reworking. |
|
i kinda did the same thing in #54 |
|
@drspangle & @leonhma to better coordinate the docs can we decide what is the best way to move forward with the docs? From our understanding (from #54) @leonhma will be made a maintainer in order to set the docs to be on read the docs & no longer using GitHub pages? If so would probably be best to let @leonhma resolve the firmware docs via their pull request instead along with removing any source files for the GitHub pages |
|
What i would do is Setup the Docs on rtd and also enable PR Preview builds. The source Files will still be kept in a folder in the GitHub repo. Sorry for the spelling/ and upper-/lowercase. Im kinda busy rn and autocorrect is very much Not helping (im German) Edit: @drspangle i Just saw the invitation from 13 days ago. I didnt get a notification from the github app though. Maybe you could resend it? |
|
@leonhma no worries on the spelling & capitalisation. @drspangle could you resend the request to @leonhma (if you haven't already) so they can make the relevant updates so they can resolve the two open pull requests? |
darigovresearch
added
documentation
|
@darigovresearch It looks like @leonhma has already accepted the invitation. |
|
@leonhma do you need anything else to resolve what is required? |
Would resolve #41 if merged