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

Clarified where to run Make commands for building documentation #5505

Merged
merged 2 commits into from
Dec 7, 2023
Merged

Clarified where to run Make commands for building documentation #5505

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9e9aa93
Clarified where to run Make commands for building documentation
stevepiercy Dec 6, 2023
068af9d
Merge branch 'main' into docs-clarify-paths
stevepiercy Dec 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/source/contributing/documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,11 @@ The {doc}`plone:index` also provides excellent references for writing high quali

### Building and checking the quality of narrative documentation

We use Make commands to run Sphinx to build and check documentation.
You can use Make commands to run Sphinx to build and check documentation.
All build and check documentation commands use the file `Makefile`.

In Volto, all documentation commands are prefixed with `docs-`.
You should run these commands from the root of the `volto` repository.

To see the all Make commands, use the following command.

Expand Down
1 change: 1 addition & 0 deletions packages/volto/news/5505.documentation
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarified where to run Make commands for building documentation. @stevepiercy