Skip to content

Commit 483c11d

Browse files
authored
Merge pull request #109 from coderefinery/radovan/word-count-template
Do not fork word-count repo, instead generate from a template
2 parents 4a20670 + 44415bc commit 483c11d

File tree

2 files changed

+6
-63
lines changed

2 files changed

+6
-63
lines changed

_episodes/04-sphinx.md

Lines changed: 0 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -335,57 +335,6 @@ This is useful to check how things look before pushing changes to GitHub or else
335335
> ```
336336
{: .task}
337337
338-
> ## Exercise: Update existing documentation that is not yours (Optional)
339-
>
340-
> Very often we are using existing software/packages that have their own documentation in [ReadTheDocs](https://readthedocs.org/).
341-
> It is good practice to participate in improving the documentation, especially when spotting problems or areas
342-
> that needs to be clarified.
343-
> The goal of this exercise is to update/improve an [existing documentation](https://word-count.readthedocs.io/en/latest/)
344-
> available on [ReadTheDocs](https://readthedocs.org/).
345-
> ### Take a few minutes to read it and before you start
346-
>
347-
> - Discuss the exercise idea with the classroom.
348-
> - Distribute exercises among groups of 2-3 persons.
349-
> - Open a GitHub issue and inform the community about the problem and how you
350-
> plan to solve it. Discuss why we do this.
351-
> - Fork this project.
352-
> - Commit to your fork. In your commit message auto-close the issue you have addressed.
353-
> - Submit a pull request.
354-
> - We then review the pull requests.
355-
> - After the pull requests are merged we verify that documentation updates itself.
356-
>
357-
>
358-
> ### Basic
359-
>
360-
> - Document the purpose of this example code.
361-
> - Document how to clone the code.
362-
> - Describe the project tree structure.
363-
> - Write a sentence or two about Zipf's law and link to Wikipedia
364-
> (coordinate with the group working on the previous exercise).
365-
> - Document how to check the code style with ``pycodestyle``.
366-
> - Give other developers hints on how they can contribute to the documentation.
367-
> - Document how to build the documentation locally
368-
> (coordinate with the group working on the previous exercise).
369-
> - Add an example output.
370-
> - Add an example plot
371-
> (coordinate with the group working on the previous exercise).
372-
> - Document where/how to ask for help.
373-
> - Add a math equation somewhere.
374-
>
375-
>
376-
> ### Advanced
377-
>
378-
> - Add a test and document how to run it.
379-
> - Add the possibility to auto-document Python code.
380-
>
381-
>
382-
> ### Meta
383-
>
384-
> - Add new exercises ideas for future workshops (edit this file).
385-
>
386-
{: .task}
387-
388-
389338
> ## Rendering (LaTeX) math equations
390339
>
391340
> There are two different ways to display mathematical equations within Sphinx: `pngmath`and `MathJax`.

_episodes/05-rtd.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -35,18 +35,18 @@ objectives:
3535

3636
> ## Exercise: Deploy Sphinx documentation to Read the Docs
3737
>
38-
> In this exercise we will fork an example repository on GitHub and deploy it to Read the Docs.
38+
> In this exercise we will make a copy of an example repository on GitHub and deploy it to Read the Docs.
3939
>
4040
> We will use GitHub for this exercise but it will also work with any Git
4141
> repository with public read access.
4242
>
43-
> 1. In the first step, fork
44-
> [this word-count example project](https://github.com/coderefinery/word-count.git) and
45-
> then clone the fork to your laptop
43+
> 1. In the first step, generate a new repository based on
44+
> [this word-count example project template](https://github.com/coderefinery/word-count/generate) and
45+
> then clone the newly created repository to your laptop.
4646
> - The project contains a script for counting the frequency distribution of words in a given file and some documentation generated using sphinx. For bigger projects, we will have much more source files.
47-
> 2. In the second step, enable the project on Read the Docs
47+
> 2. In the second step, enable the project on Read the Docs.
4848
>
49-
> ### Step 1: Fork the [word-count project](https://github.com/coderefinery/word-count.git) and clone the repository
49+
> ### Step 1: Go to the [word-count project template](https://github.com/coderefinery/word-count/generate), copy it to your namespace, and clone the repository
5050
>
5151
> - The repository contains following two folders, among few other files and folder.
5252
> - **source** folder contains the source code
@@ -106,12 +106,6 @@ objectives:
106106
>
107107
{: .callout}
108108
109-
> ## (Optional) Create a pull request to the central repository
110-
>
111-
> It might be fun to collect the documentation contributions from everyone into the same
112-
> central repository.
113-
{: .task}
114-
115109
> ## Running your own sphinx server
116110
>
117111
> We recommend to use Read the Docs to host your documentation but this may

0 commit comments

Comments
 (0)