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.

Sign up for GitHub

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

Jump to bottom

Add sphinx-based documentation #88

Merged
merged 15 commits into from
Dec 14, 2020
Merged

Add sphinx-based documentation #88

merged 15 commits into from
Dec 14, 2020

Conversation

rw1nkler
Copy link
Contributor

@rw1nkler rw1nkler commented Dec 8, 2020

This PR replaces README-based documentation with a Sphinx-based version. The PR provides:

  • CI tutorial tests (with tuttest)
  • artifacts uploading in the CI
  • sphinx docs directory
  • RTD config

@rw1nkler rw1nkler changed the title [WIP] Add sphinx-based documentation Add sphinx-based documentation Dec 8, 2020
@rw1nkler
Copy link
Contributor Author

rw1nkler commented Dec 8, 2020

This PR does not include the simple_litex demo. It will be included later.
(I have to rebase #55 after merging this PR)

@tmichalak tmichalak requested a review from mithro December 8, 2020 19:14
mithro
mithro reviewed Dec 8, 2020
View reviewed changes
Copy link
Contributor

@mithro mithro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documentation looks really good! Let's get this merged ASAP.

My only questions seem to be about the tuttest integration.

.github/scripts/build.sh Outdated Show resolved Hide resolved
.github/scripts/build.sh Outdated Show resolved Hide resolved
.github/scripts/install-deps.sh Outdated Show resolved Hide resolved
.github/scripts/install-deps.sh Outdated Show resolved Hide resolved
.github/scripts/install-deps.sh Outdated Show resolved Hide resolved
docs/building-examples.rst Show resolved Hide resolved
docs/index.rst Outdated Show resolved Hide resolved
@rw1nkler rw1nkler mentioned this pull request Dec 9, 2020
Merged
@mithro
Copy link
Contributor

mithro commented Dec 9, 2020

Needs a rebase.

@rw1nkler rw1nkler force-pushed the sphinx_docs_cleaned branch 5 times, most recently from ba8990a to 4e7677d Compare December 11, 2020 09:33
@fkokosinski @rw1nkler
docs: Initial Sphinx setup
2ddee57 
Signed-off-by: Filip Kokosinski <fkokosinski@antmicro.com>
@fkokosinski @rw1nkler
xc7: Add README for counter_test
564ad12 
Signed-off-by: Filip Kokosinski <fkokosinski@antmicro.com>
@fkokosinski @rw1nkler
xc7: Add README for linux_litex_demo
b0937e0 
Signed-off-by: Filip Kokosinski <fkokosinski@antmicro.com>
@fkokosinski @rw1nkler
xc7: Add README for picosoc_demo
b35be0e 
Signed-off-by: Filip Kokosinski <fkokosinski@antmicro.com>
@fkokosinski @rw1nkler
eos-s3: Add README for btn_counter example
2fbbf64 
Signed-off-by: Filip Kokosinski <fkokosinski@antmicro.com>
@rw1nkler rw1nkler requested a review from mithro December 11, 2020 14:29
mithro
mithro approved these changes Dec 11, 2020
View reviewed changes
Copy link
Contributor

@mithro mithro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bunch of small comments, if you fix them, I think you can go ahead and merge.

Love the new images! Can you log an issue to get stabilized LED graphics? (Not blocking merging.)

.github/scripts/build-examples.sh Show resolved Hide resolved
.github/scripts/build-examples.sh Show resolved Hide resolved
.github/scripts/common.sh Show resolved Hide resolved
.github/scripts/install-toolchain.sh Show resolved Hide resolved
.github/workflows/sphinx-tuttest.yml Show resolved Hide resolved
docs/Makefile Outdated Show resolved Hide resolved
docs/conf.py Show resolved Hide resolved
docs/conf.py Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
@acomodi acomodi mentioned this pull request Dec 11, 2020
Merged
This was referenced Dec 14, 2020
Open
Open
fkokosinski and others added 6 commits December 14, 2020 14:45
@fkokosinski @rw1nkler
readme: Remove README-based documentation structure
54c9bea 
Signed-off-by: Filip Kokosinski <fkokosinski@antmicro.com>
@fkokosinski @rw1nkler
ci: Adjust CI to sphinx-based documentation
0e4eeba 
Signed-off-by: Filip Kokosinski <fkokosinski@antmicro.com>
@rw1nkler
ci: Add artifacts collection
c9a5d6f 
Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
@rw1nkler
ci: Extract tuttest runs from docker
f579ebf 
Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
@rw1nkler
docs: Add readthedocs config
8b9559c 
Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
@rw1nkler
docs: Update prerequisites
fd559b5 
Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
@rw1nkler
docs: Update description
29ba427 
Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
@rw1nkler
docs: Move example collection code to separate file
613b8ea 
Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
@rw1nkler
Add license headers to docs and CI scripts
e3b82cf 
Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
@rw1nkler
README: Change badge link
10a7dbe 
Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
@rw1nkler rw1nkler mentioned this pull request Dec 14, 2020
Open
@rw1nkler
Copy link
Contributor Author

Love the new images! Can you log an issue to get stabilized LED graphics? (Not blocking merging.)

Here is the issue: #95

tmichalak
tmichalak approved these changes Dec 14, 2020
View reviewed changes
Copy link
Collaborator

@tmichalak tmichalak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@tmichalak tmichalak merged commit 2bf0a5b into chipsalliance:master Dec 14, 2020
@rw1nkler rw1nkler mentioned this pull request Dec 15, 2020
Merged
@umarcor umarcor deleted the sphinx_docs_cleaned branch March 24, 2022 17:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tmichalak tmichalak tmichalak approved these changes

@mithro mithro mithro approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@rw1nkler @mithro @tmichalak @fkokosinski