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

Better autogenerated index file #3447

Merged
merged 5 commits into from Dec 28, 2017

Conversation

@stsewd
Copy link
Member

@stsewd stsewd commented Dec 26, 2017

Related issue #3351

Here is how it looks

This image is out of date
index

@stsewd
Copy link
Member Author

@stsewd stsewd commented Dec 26, 2017

In this commit 0fcbe84 is the change, the other changes are from pre-commit command.

Copy link
Member

@humitos humitos left a comment

Thanks for this PR. This looks great.

Two English related things, but I'm not sure if I'm correct.

@@ -101,7 +106,8 @@ def create_index(self, extension='md', **__):
This is an autogenerated index file.
Please create a ``{dir}/index.{ext}`` or ``{dir}/README.{ext}`` file with your own content.
Please create a ``index.{ext}`` or ``README.{ext}`` file with your own content
Copy link
Member

@humitos humitos Dec 26, 2017

I think it should be an here instead of a since the next word is a vocal.

@@ -101,7 +106,8 @@ def create_index(self, extension='md', **__):
This is an autogenerated index file.
Please create a ``{dir}/index.{ext}`` or ``{dir}/README.{ext}`` file with your own content.
Please create a ``index.{ext}`` or ``README.{ext}`` file with your own content
under the root directory in your repository (or under ``/docs`` directory).
Copy link
Member

@humitos humitos Dec 26, 2017

I just realized that this could sound repetitive, so maybe it could be better

under the root (or /docs) directory in your repository.

@ericholscher
Copy link
Member

@ericholscher ericholscher commented Dec 26, 2017

This looks like a good start. We should probably link to some resources that might help folks along, if we really want to make this better. Perhaps our getting started doc guide (http://docs.readthedocs.io/en/latest/getting_started.html)?

If you want to use another markup, choose a different builder in your settings.
Check out our `Getting Started Guide
<https://docs.readthedocs.io/en/latest/getting_started.html>`_ to become more
Copy link
Member Author

@stsewd stsewd Dec 26, 2017

I'm not sure if the English is right

Copy link
Member

@RichardLitt RichardLitt Dec 27, 2017

Looks fine to me.

If you want to use another markup, choose a different builder in your settings.
Check out our `Getting Started Guide
<https://docs.readthedocs.io/en/latest/getting_started.html>`_ to become more
familiar with Read The Docs.
Copy link
Member

@ericholscher ericholscher Dec 27, 2017

Read the Docs is the brand.

@ericholscher ericholscher merged commit 3de48a0 into readthedocs:master Dec 28, 2017
1 check passed
@stsewd stsewd deleted the better-autogen-index branch Dec 28, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants