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

Minor doc tweaks #83

Merged
merged 19 commits into from
Jan 26, 2024
Merged

Minor doc tweaks #83

merged 19 commits into from
Jan 26, 2024

Conversation

AdrianSosic
Copy link
Collaborator

@AdrianSosic AdrianSosic commented Jan 11, 2024

A collection of minor (mostly non-content changing) doc tweaks.

@AdrianSosic AdrianSosic added the documentation Improvements or additions to documentation label Jan 11, 2024
@AdrianSosic AdrianSosic self-assigned this Jan 11, 2024
@AdrianSosic
Copy link
Collaborator Author

Hi @AVHopp, @Scienfitz, I open this PR to have a place for minor doc tweaks (configuration-wise). I don't intent do merge this right now but keep it open for a week or so, probably there will be more stuff coming up. Is there anything you noticed that we could include as well?

@Scienfitz
Copy link
Collaborator

this is till there: https://github.com/emdgroup/baybe/discussions/52

@Scienfitz
Copy link
Collaborator

Scienfitz commented Jan 11, 2024

some pages in the autodoc for some reason cut off the right margin, I suspect because somethign in the content is too long: eg
image
image
image

as opposed to normal looking:
image

@AVHopp
Copy link
Collaborator

AVHopp commented Jan 12, 2024

We might want to rethink the options for building the docs. For example, is the force option still necessary?

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@AdrianSosic
Copy link
Collaborator Author

Ok folks (@AVHopp, @Scienfitz), let's try to wrap this PR up 👍🏼

README.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@AdrianSosic AdrianSosic merged commit eba7946 into main Jan 26, 2024
9 checks passed
@AdrianSosic AdrianSosic deleted the docs/tweaks branch January 26, 2024 12:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants