infidel-sensor icon indicating copy to clipboard operation
infidel-sensor copied to clipboard

feat: Adds firmware content to documentation

Open darigovresearch opened this issue 4 years ago • 9 comments

Would resolve #41 if merged

darigovresearch avatar Jun 20 '21 16:06 darigovresearch

@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 intersphinx, can you provide links and what was the procedure that you used to build the docs?

darigovresearch avatar Jun 26 '21 13:06 darigovresearch

I think this is no longer necessary anymore.

drspangle avatar Jul 10 '21 17:07 drspangle

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.

drspangle avatar Jul 10 '21 17:07 drspangle

i kinda did the same thing in #54

leonhma avatar Jul 11 '21 10:07 leonhma

@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

darigovresearch avatar Jul 24 '21 16:07 darigovresearch

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 avatar Jul 24 '21 17:07 leonhma

@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 avatar Aug 08 '21 20:08 darigovresearch

@darigovresearch It looks like @leonhma has already accepted the invitation.

drspangle avatar Aug 09 '21 15:08 drspangle

@leonhma do you need anything else to resolve what is required?

darigovresearch avatar Aug 29 '21 19:08 darigovresearch