Skip to content
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

Add/fix ReadTheDocs badge #613

Closed
20 tasks done
tannewt opened this issue Feb 12, 2018 · 4 comments
Closed
20 tasks done

Add/fix ReadTheDocs badge #613

tannewt opened this issue Feb 12, 2018 · 4 comments

Comments

@tannewt
Copy link
Member

tannewt commented Feb 12, 2018

We had a bad cookiecutter for a while that added extra lines into the README.rst in the ReadTheDocs badge like this:

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-vcnl4010/badge/?version=latest

    :target: https://circuitpython.readthedocs.io/projects/vcnl4010/en/latest/

    :alt: Documentation Status

It should be:

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-vcnl4010/badge/?version=latest
    :target: https://circuitpython.readthedocs.io/projects/vcnl4010/en/latest/
    :alt: Documentation Status

These are super simple changes that are great practice for using GitHub. Feel free to ask questions here as needed.

These repos need a look:

Part of #566

@brentru
Copy link
Member

brentru commented Feb 14, 2018

@tannewt I noticed the SSD1306 repo 404's on its ReadTheDocs page. Is there another ReadTheDocs page, or a correct link to this badge?

Also - the register library doesn't seem to follow the default badge URL path, is there a correct URL for this?

@tannewt
Copy link
Member Author

tannewt commented Feb 14, 2018

Thats the right link for ssd1306 but the build itself isn't set up right. The build output is here: https://readthedocs.org/projects/adafruit-circuitpython-ssd1306/builds/6661205/

I'd expect register to be at https://circuitpython.readthedocs.io/projects/register/en/latest/

@mrmcwethy
Copy link
Collaborator

@ tannewt @brentru I believe this issue can now be closed.

@tannewt
Copy link
Member Author

tannewt commented Feb 20, 2018

Great job @mrmcwethy and @brentru !

@tannewt tannewt closed this as completed Feb 20, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants