HOT FIX: Update docs #658
HOT FIX: Update docs #658
Conversation
…_programming_course # Conflicts: # cmake/gtest.cmake # cmake/json.cmake # cmake/libenvpp.cmake # cmake/mpi.cmake # cmake/onetbb.cmake # cmake/openmp.cmake # cmake/stb.cmake
…ct task descriptions
…p sections, replace outdated diagrams
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #658 +/- ##
=======================================
Coverage 64.91% 64.91%
=======================================
Files 15 15
Lines 456 456
Branches 166 166
=======================================
Hits 296 296
Misses 136 136
Partials 24 24 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
@aobolensk please check it |
1 similar comment
|
@aobolensk please check it |
docs/common_information/report.rst
Outdated
| - If the task is disabled at the end of semester (e.g., fails in master; see scoreboard “blue zone”), report points for that task are nullified. | ||
| - Plagiarism is prohibited; identical or near‑duplicate reports will be rejected. | ||
|
|
||
| .. ifconfig:: language == 'en' |
There was a problem hiding this comment.
This is definitely an antipattern to use such ifs in sphinx docs. Everywhere
| "Generated-By: Babel 2.17.0\n" | ||
|
|
||
| #: ../../common_information/introduction.rst:2 | ||
| #: ../../../../docs/common_information/introduction.rst:2 |
There was a problem hiding this comment.
Please, avoid dummy path changes. Again, everywhere. Consider following the docs instruction to rebuild docs in order to avoid such changes
There was a problem hiding this comment.
The point of previous graph was to be automatically updateable. Here it is very diffeicult to keep it clear all the time. As you know, CI pipeline part is intended to be changed quite often, so it is impractical to keep unmaintainable svgs
| Introduction | ||
| ============ | ||
|
|
||
| Contacts |
There was a problem hiding this comment.
Is that needed here? For external contributors the primary contact is issue tracker. For students - it is already listed in the slides
| It can be seen that your task is disabled due to the following reason: the directory of your task has been renamed | ||
| from ``seq/nesterov_a_vector_sum`` to ``seq/nesterov_a_vector_sum_disabled`` | ||
|
|
||
| Communication |
There was a problem hiding this comment.
Same question, is it needed here?
| #: ../../../../docs/user_guide/ci.rst:152 | ||
| msgid "" | ||
| "macOS - clang-tidy: ``brew install llvm``; binary at ``$(brew " | ||
| "--prefix)/opt/llvm/bin/clang-tidy``. - Optionally add LLVM to PATH or " |
There was a problem hiding this comment.
Since adding to PATH is officially recommended by LLVM installer in brew, I suggest to rely on the fact that clang-tidy is available on the PATH. Let's not suplicate the official docs
| " can be considered for submission. This includes successful code " | ||
| "checkout, build ans testing stages. Each integration is verified by an " | ||
| "automated build and automated tests." | ||
| "Docs build fails: fix RST warnings; run ``doxygen Doxyfile`` before " |
| msgid "Performance Module" | ||
| msgstr "" | ||
|
|
||
| #~ msgid "Functions" |
…ine rules on task deadlines and reports
allnes
force-pushed
the
an/update-docs
branch
from
01c8165 to
c0ead74
Compare
2 participants
Please go to the
Previewtab and select the appropriate template: