Skip to content

docs/README: Add readthedocs-howto#5498

Closed
tve wants to merge 1 commit into
micropython:masterfrom
tve:tve-readthedocs-howto
Closed

docs/README: Add readthedocs-howto#5498
tve wants to merge 1 commit into
micropython:masterfrom
tve:tve-readthedocs-howto

Conversation

@tve
Copy link
Copy Markdown
Contributor

@tve tve commented Jan 6, 2020

This adds a short paragraph on how to hook readthedocs.org up.
Not that it is rocket science, the main goal is to make people aware of the option
(hadn't occurred to me).

This adds a short paragraph on how to hook readthedocs.org up.
Not that it is rocket science, the main goal is to make people aware of the option
(hadn't occurred to me).
@dpgeorge
Copy link
Copy Markdown
Member

dpgeorge commented Jan 7, 2020

I don't personally see the benefit of this. Isn't it far easier to just build the docs locally as you make changes?

@dpgeorge dpgeorge added the docs label Jan 7, 2020
@tve
Copy link
Copy Markdown
Contributor Author

tve commented Jan 7, 2020

  1. depends on your tolerance towards installing yet another software package that you then need to update, etc.
  2. in Addition of a machine.Counter class (ESP32 only initially) #5496 I started a feature from the docs and it's nice to be able to point reviewers at the doc site instead of forcing them to read the source or download&build just to read
  3. I authored this PR on github directly by using the edit-file feature, this way I avoided all the git-fu to stash, branch, add, commit, push; so no local docs

Overall it's a small paragraph that doesn't clutter the page much and doesn't need maintenance, but if you don't like it just close the PR...

@tve tve changed the title Add readthedocs-howto docs/README: Add readthedocs-howto Jan 9, 2020
@dpgeorge
Copy link
Copy Markdown
Member

Ok, thanks for the reasoning, sounds good to help people contribute to the docs. Rebased and merged in bc5c993

@dpgeorge dpgeorge closed this Jan 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants