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

docs: switch doc generation to mkdocs #1919

Merged
merged 2 commits into from
Sep 15, 2023
Merged

docs: switch doc generation to mkdocs #1919

merged 2 commits into from
Sep 15, 2023

Conversation

sanzoghenzo
Copy link
Contributor

Hi, this is the PR to move to mkdocs!

The automatic publishing is done by .github/workflows/docs.yml;
As of now it triggers on pushes to docs branch and when a PR is issued on main branch;
should I change it to only trigger on pushes to main branch, or even better only on new releases?

To answer your question from the forum, this is what it needs to be done:

image

  • go to settings
  • select the page section
  • under "Source" select "Deploy from a branch"
  • select the "gh-pages" branch (it should be created the first time that the workflow runs) then click save.

@sanzoghenzo
docs: switch doc generation to mkdocs
78b2eb7 
Uses mkdocs material and mkdocstrings
to build the documentation from docstrings.
Adds a github workflow to publish it to github pages
when pushing on the master and docs branch
Local builds use the root pipenv via the command "pipenv run docs"
@jmcouffin jmcouffin added the Wiki Issues related to Wiki or Documentation [subsystem] label Sep 14, 2023
@jmcouffin
Copy link
Contributor

@sanzoghenzo 🎩 off
Great job.
I will try it on my side

@jmcouffin
Copy link
Contributor

Looks good on my fork
I will give it a try on the dev branch then! 🤞

@jmcouffin jmcouffin merged commit 8515229 into pyrevitlabs:develop Sep 15, 2023
@github-actions
Copy link
Contributor

📦 New work-in-progress (wip) builds are available for 4.8.14.23258+1333-wip

@github-actions
Copy link
Contributor

📦 New work-in-progress (wip) builds are available for 4.8.14.23270+1045-wip

@github-actions
Copy link
Contributor

📦 New work-in-progress (wip) builds are available for 4.8.14.23272+1052-wip

@github-actions
Copy link
Contributor

📦 New work-in-progress (wip) builds are available for 4.8.14.23273+0712-wip

@github-actions
Copy link
Contributor

github-actions bot commented Oct 3, 2023

📦 New work-in-progress (wip) builds are available for 4.8.14.23276+0814-wip

@github-actions
Copy link
Contributor

📦 New work-in-progress (wip) builds are available for 4.8.14.23289+0854-wip

@github-actions
Copy link
Contributor

📦 New work-in-progress (wip) builds are available for 4.8.14.23290+1050-wip

@github-actions
Copy link
Contributor

📦 New work-in-progress (wip) builds are available for 4.8.14.23290+1104-wip

@github-actions
Copy link
Contributor

📦 New work-in-progress (wip) builds are available for 4.8.14.23291+0959-wip

@github-actions
Copy link
Contributor

📦 New work-in-progress (wip) builds are available for 4.8.14.23291+1028-wip

@github-actions
Copy link
Contributor

📦 New work-in-progress (wip) builds are available for 4.8.14.23291+1125-wip

@github-actions
Copy link
Contributor

📦 New work-in-progress (wip) builds are available for 4.8.14.23293+0837-wip

@sanzoghenzo sanzoghenzo deleted the mkdocs branch October 20, 2023 08:52
@github-actions
Copy link
Contributor

📦 New work-in-progress (wip) builds are available for 4.8.14.23293+1010-wip

@github-actions
Copy link
Contributor

📦 New work-in-progress (wip) builds are available for 4.8.14.23293+1303-wip

@github-actions
Copy link
Contributor

📦 New work-in-progress (wip) builds are available for 4.8.14.23295+2104-wip

@github-actions
Copy link
Contributor

📦 New work-in-progress (wip) builds are available for 4.8.14.23295+2132-wip

@github-actions
Copy link
Contributor

📦 New work-in-progress (wip) builds are available for 4.8.14.23296+0902-wip

@github-actions
Copy link
Contributor

📦 New work-in-progress (wip) builds are available for 4.8.14.23299+1941-wip

@github-actions
Copy link
Contributor

📦 New work-in-progress (wip) builds are available for 4.8.14.23304+0918-wip

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 6, 2023

📦 New work-in-progress (wip) builds are available for 4.8.14.23310+1210-wip

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 9, 2023

📦 New work-in-progress (wip) builds are available for 4.8.14.23313+1353-wip

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 9, 2023

📦 New work-in-progress (wip) builds are available for 4.8.14.23313+1412-wip

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 9, 2023

📦 New work-in-progress (wip) builds are available for 4.8.14.23313+2035-wip

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 9, 2023

📦 New work-in-progress (wip) builds are available for 4.8.14.23313+2133-wip

@github-actions GitHub Actions
Copy link
Contributor

📦 New work-in-progress (wip) builds are available for 4.8.14.23326+1241-wip

@github-actions GitHub Actions
Copy link
Contributor

📦 New work-in-progress (wip) builds are available for 4.8.14.23326+2020-wip

@github-actions GitHub Actions
Copy link
Contributor

📦 New work-in-progress (wip) builds are available for 4.8.14.23327+1037-wip

@github-actions GitHub Actions
Copy link
Contributor

📦 New work-in-progress (wip) builds are available for 4.8.14.23328+0920-wip

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 1, 2023

📦 New work-in-progress (wip) builds are available for 4.8.14.23335+1813-wip

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 4, 2023

📦 New work-in-progress (wip) builds are available for 4.8.14.23338+0813-wip

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 6, 2023

📦 New work-in-progress (wip) builds are available for 4.8.14.23340+1759-wip

@github-actions GitHub Actions
Copy link
Contributor

📦 New work-in-progress (wip) builds are available for 4.8.14.23346+0717-wip

@github-actions GitHub Actions
Copy link
Contributor

📦 New work-in-progress (wip) builds are available for 4.8.14.23352+1117-wip

@github-actions GitHub Actions
Copy link
Contributor

📦 New work-in-progress (wip) builds are available for 4.8.14.23352+1544-wip

@github-actions GitHub Actions
Copy link
Contributor

📦 New work-in-progress (wip) builds are available for 4.8.14.23353+1120-wip

@github-actions GitHub Actions
Copy link
Contributor

📦 New work-in-progress (wip) builds are available for 4.8.14.23353+1222-wip

@github-actions GitHub Actions
Copy link
Contributor

📦 New work-in-progress (wip) builds are available for 4.8.14.23354+0922-wip

@github-actions GitHub Actions
Copy link
Contributor

📦 New work-in-progress (wip) builds are available for 4.8.14.23354+1019-wip

@github-actions GitHub Actions
Copy link
Contributor

📦 New work-in-progress (wip) builds are available for 4.8.14.23354+1055-wip

@github-actions GitHub Actions
Copy link
Contributor

📦 New work-in-progress (wip) builds are available for 4.8.14.24012+1924-wip

@github-actions GitHub Actions
Copy link
Contributor

📦 New public release are available for 4.8.14.24016+1909

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eirannejad eirannejad Awaiting requested review from eirannejad

Assignees

@eirannejad eirannejad

Labels
Wiki Issues related to Wiki or Documentation [subsystem]
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@sanzoghenzo @jmcouffin @eirannejad