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

migen README still doesn't link to the readthedocs.org documentation - is there something wrong with it? #13

Closed
mithro opened this issue Apr 19, 2015 · 5 comments

Comments

@mithro
Copy link
Contributor

mithro commented Apr 19, 2015

Looks like when my readme-update changes were merged the following was changed;

++<<<<<<< HEAD
 +http://m-labs.hk/gateware.html
++=======
+ http://migen.readthedocs.org/en/latest/
+ 
+ Install instructions:
+ https://migen.readthedocs.org/en/latest/introduction.html#installing-migen
++>>>>>>> 62d264e... Adding links to the readthedocs.org documentation.

Adding the http://m-labs.hk/gateware.html link is a good idea (the user guide, tutorial and lecture slide stuff is pretty awesome!)

However, I was wondering why the links to readthedocs documentation was dropped? I was also unable to find any links to the readthedocs page on the gateware page. Is there something wrong with the documentation at migen.readthedocs.org?

@sbourdeauducq
Copy link
Member

The readthedocs content is fine, but I'd just like to keep all docs in one place (the artiq and pyparser html docs are already on m-labs.hk, as well as the pdf docs for migen).

@mithro
Copy link
Contributor Author

mithro commented Apr 20, 2015

Could we add a link to the readthedocs stuff on http://m-labs.hk/gateware.html then?

@sbourdeauducq
Copy link
Member

What's wrong with the existing pdf?

@mithro
Copy link
Contributor Author

mithro commented Apr 20, 2015

I didn't actually even realise it was the same documentation, I find the HTML documents much nicer to read personally.

The HTML documents are also updated on every commit to your repo if you add a github hook too.

@sbourdeauducq
Copy link
Member

Let's put all the docs in http://m-labs.hk/migen/manual/
(This is for the new branch)

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