Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
jami-docs
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
savoirfairelinux
jami-docs
Commits
7d93dc06
Commit
7d93dc06
authored
2 years ago
by
Tobias Hildebrandt
Committed by
Adrien Béraud
2 years ago
Browse files
Options
Downloads
Patches
Plain Diff
add sphinx-autobuild
Change-Id: Idbb6976e34f029b6017a16fe5d8355c87b649315
parent
4a783ac0
No related branches found
No related tags found
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
Makefile
+5
-0
5 additions, 0 deletions
Makefile
guides/how-to-contribute-to-this-documentation.rst
+16
-0
16 additions, 0 deletions
guides/how-to-contribute-to-this-documentation.rst
with
21 additions
and
0 deletions
Makefile
+
5
−
0
View file @
7d93dc06
...
...
@@ -26,5 +26,10 @@ help:
.PHONY
:
help Makefile
# specific rule to use sphinx-autobuild
watch
:
Makefile
@
sphinx-autobuild
-b
html
"
$(
SRC
)
"
"
$(
OUT
)
"
/html
$(
OPTS
)
# anything else
%
:
Makefile
@$(
CMD
)
-M
$@
"
$(
SRC
)
"
"
$(
OUT
)
"
$(
OPTS
)
This diff is collapsed.
Click to expand it.
guides/how-to-contribute-to-this-documentation.rst
+
16
−
0
View file @
7d93dc06
...
...
@@ -32,6 +32,12 @@ and the `MyST Markdown parser
$ pip install --upgrade sphinx sphinx_rtd_theme myst_parser
If you want to use the auto-build and auto-refresh feature, also install
`sphinx-autobuild <https://github.com/executablebooks/sphinx-autobuild>`_.
.. code-block:: bash
$ pip install --upgrade sphinx-autobuild
Cloning the repository
======================
...
...
@@ -75,6 +81,16 @@ From the base of the repository, run:
You should now be able to view the documentation in your web
browser. The homepage is at ``_build/html/index.html``.
To automatically build the documentation and refresh your web browser whenever
you save changes, run:
.. code-block:: bash
$ make clean && make watch
Keep this running in the background, then navigate to http://127.0.0.1:8000
(*not* the local .html file).
Saving your work
================
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment