Add a job to build the docs on CI #1107
Conversation
This reverts commit 2af36bf.
…o airspeed-velocity-master
LucyJimenez
changed the title
LucyJimenez
changed the title
|
Did you check if the docs are being built correctly? |
Yes, now it’s possible to create the HTML. I’m working on fixing the problems, and I’ll be listing the issues here.
|
|
@datapythonista The PR is ready for your review; thanks! |
.github/workflows/ci.yml
Outdated
| @@ -47,3 +47,18 @@ jobs: | |||
|
|
|||
| - name: Check code with flake8 | |||
| run: flake8 . | |||
|
|
|||
| docs: | |||
| name: builds the documentation using Sphinx | |||
There was a problem hiding this comment.
I think you can delete this row. The default docs is easier to read in my opinion.
.github/workflows/ci.yml
Outdated
| - name: Install asv | ||
| run: pip install . | ||
|
|
||
| - name: build-command |
There was a problem hiding this comment.
Build docs is probably a clear name
docs/source/benchmarks.rst
Outdated
| @@ -146,7 +146,7 @@ Timing benchmarks | |||
| benchmark. Default: 2 | |||
|
|
|||
| - ``timer``: The timing function to use, which can be any source of | |||
| monotonically increasing numbers, such as `time.clock`, `time.time` | |||
| monotonically increasing numbers, such as `time.time` | |||
There was a problem hiding this comment.
This doesn't make a lot of sense. Just leave both time.clock and time.time escaped with double backticks, as the rest of things in this section.
docs/source/reference.rst
Outdated
| @@ -3,6 +3,7 @@ Reference | |||
|
|
|||
| .. toctree:: | |||
|
|
|||
| manindex.rst | |||
There was a problem hiding this comment.
This seems to be a duplicate of reference, just remove the page instead of including it here.
docs/source/writing_benchmarks.rst
Outdated
| @@ -277,7 +277,7 @@ How ASV runs benchmarks is as follows (pseudocode for main idea):: | |||
| sample = timing_function(<run benchmark `number` times>) / `number` | |||
| <teardown `benchmark`> | |||
|
|
|||
| where the actual `rounds`, `repeat`, and `number` are :doc:`attributes | |||
| where the actual :doc:`rounds <benchmarks>`, :doc:`repeat <benchmarks>`, and :doc:`number <benchmarks>` are :doc:`attributes | |||
There was a problem hiding this comment.
No idea what this is supposed to do, but just use double backticks.
|
@datapythonista, I included the last comments. The PR is ready for review. Thanks a lot! |
| @@ -46,6 +46,20 @@ jobs: | |||
|
|
|||
| - name: flake8 | |||
| run: flake8 . | |||
|
|
|||
There was a problem hiding this comment.
You should review the diffs when you're done, and things like this shouldn't be introduced by mistake.
|
Thanks @LucyJimenez |
xref #1063
On this PR create a job for docs