Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation and package maintenance #481

Merged
merged 6 commits into from
May 13, 2021
Merged

Conversation

JoranAngevaare
Copy link
Contributor

What is the problem / what does the code in this PR do

Can you briefly describe how I can make the documentation locally

# navigate to straxen/docs
cd .../straxen/docs
bash make_docs.sh

Probably, you need to install some packages, retry until you have all the sphinx requirements and similar installed. There will be some error warnings but those are mostly related to some badly formatted docstring, which is not a huge deal.

Examples

Readme

I've reshuffled and added some of the current status fields.
afbeelding

Documentation

After the update, the sidebar looks like this:
afbeelding

The online monitor documentation

afbeelding

Scripts documentation

afbeelding

Bootstrax documentation

afbeelding

@JoranAngevaare JoranAngevaare marked this pull request as ready for review May 7, 2021 21:05
@JoranAngevaare JoranAngevaare added the documentation Something should be addressed in the docs label May 7, 2021
This was linked to issues May 7, 2021
@JoranAngevaare JoranAngevaare changed the title Package maintenance & documentation Documentation and package maintainance May 7, 2021
@JoranAngevaare JoranAngevaare self-assigned this May 7, 2021
@JoranAngevaare JoranAngevaare removed their assignment May 7, 2021
@JoranAngevaare JoranAngevaare requested a review from kdund May 12, 2021 07:01
@JoranAngevaare JoranAngevaare merged commit 42d3f38 into master May 13, 2021
@JoranAngevaare JoranAngevaare deleted the package_maintenance branch May 13, 2021 08:25
@JoranAngevaare JoranAngevaare changed the title Documentation and package maintainance Documentation and package maintenance May 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Something should be addressed in the docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Refactor bootstrax Documentation Scada and CMT
1 participant