documentation

documentation copied to clipboard

Just making use of this example and I noticed the action versions are a bit behind the current versions. thought it might be worth updating them. thanks for making the...

shimwell

Instead of starting from zero and adding to it we could start from something small and working which learners adjust. This is possibly more realistic and it would also avoid...

bast

The index file in a Sphinx project should not be .rst

2

See the index file for this lesson: https://github.com/coderefinery/documentation/pull/284

bast

We need to update the R docstring example to actually provide types for the Inputs and outputs.

1

(copied from chat)

bast

Link to generated PDF

5

We plan to generate PDF as part of the Sphinx workflow. Let's not forget to link to the PDF from somewhere so that we find it. It is currently called...

bast

Math expression rendered as "\[a^2 + b^2 = c^2\]" in pdf file

6

Hi, It looks like the pdf generation does not work properly with math expression. The lesson.pdf file contains "\[a^2 + b^2 = c^2\]" instead of the "real" math expression. Fred

FredM67

Generate pdf matches Web-Documention design but has not TOC ...

2

The generated pdf matches the design of the Web-Document, but has a couple of issues: - no TOC - since no TOC, no way to jump directly to a chapter...

FredM67

Replace instructions in step 2 with a pure markdown solution

7

As in issue #295

rantahar

Step 2 in the autodoc exercise can be this: ```` :::{automodule} example :members: ::: ```` This is the general way to call any Sphinx directive from MyST-parser.

rkdarst

In the section [In-code documentation — How to document your research software documentation](https://coderefinery.github.io/documentation/in-code-documentation/#what-are-docstrings-and-how-can-they-be-useful) it reads > Read more: [https://peps.python.org/pep-0257/](https://peps.python.org/pep-0257/) although the PEP does not specify any particular format or convention...

ashwinvis