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

✨ NEW: Add RTD site #33

Merged
merged 5 commits into from
Dec 16, 2021
Merged

Conversation

chrisjsewell
Copy link
Member

Because why not!

  • Used AEP template from AEP 0
  • Status is submitted
  • Added type & status labels to PR
  • Added AEP to README.md
  • Provided github handles for authors

Because why not!
@sphuber
Copy link
Contributor

sphuber commented Dec 16, 2021

Nice. Should we maybe put the doc-specific files in a docs sub directory to keep root from getting to cluttered?

@chrisjsewell
Copy link
Member Author

Should we maybe put the doc-specific files in a docs sub directory to keep root from getting to cluttered?

Ah but then I believe you would have to put all the documentation under the docs directory, which is obviously everything in the repository lol

@chrisjsewell
Copy link
Member Author

There you go: https://aep--33.org.readthedocs.build/en/33/

@chrisjsewell chrisjsewell requested a review from sphuber December 16, 2021 16:16
@chrisjsewell
Copy link
Member Author

All done on my end.
Note, when you add a new AEP, you just need to add it to _toc.yml

@sphuber
Copy link
Contributor

sphuber commented Dec 16, 2021

Note, when you add a new AEP, you just need to add it to _toc.yml

Would be good to add this to the steps for submitting an AEP in AEP 000.

Copy link
Member

@ltalirz ltalirz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @chrisjsewell !

Should we maybe put the doc-specific files in a docs sub directory to keep root from getting to cluttered?

Ah but then I believe you would have to put all the documentation under the docs directory, which is obviously everything in the repository lol

I would also have preferred that but if there's no way to do a ../ there, it's ok with me.

root: README.md
subtrees:
- caption: Proposals
entries:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's no way to automate this, right?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nope, not currently

@chrisjsewell chrisjsewell merged commit a267c77 into aiidateam:master Dec 16, 2021
@chrisjsewell chrisjsewell deleted the add-docs branch December 16, 2021 16:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants