Docs and Web: Add to the master branch and build with each push #764
Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
|
@yarda, technically, the static webpage files could be kept in the |
zacikpa
force-pushed
the
doc-build
branch
5 times, most recently
from
85e4c16 to
65c5e73
Compare
|
I changed my opinion: it is probably neater to keep the static files in I also opened #765 which should be merged alongside this PR. When the PRs are merged, the repository also needs a manual update of the settings to make it build the website using the workflow. |
Read the docstrings using ASTs instead of importing the modules; this prevents the need to install TuneD dependencies when just building the docs (e.g., in Github Pages).
The docs are now asciidoc with examples, ready to be included into the manual.
This is the standard in Python and it prevents the issue of using reserved/existing names, e.g., in the case of the `exec` or `log` function.
Prevents redundancy. The same thing is already done for plugins.
The manual is now built automatically with each push to the master branch.
- remove duplicate sections - move profile syntax description to the second module - move mention of profile merging after list of profiles
|
I did some minor changes to the docs themselves, e.g., updates from |
In this PR, I propose to move the webpage files from the
gh-pagesto the master branch. The webpage (preview at https://zacikpa.github.io/tuned/) now contains a link to the documentation (preview at https://zacikpa.github.io/tuned/docs/manual.html), which would be automatically deployed with each push to master.The documentation of plug-ins and built-in functions is built from code docstrings.
The PR contains some additional refactoring of TuneD built-in functions, see the individual commits.