Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
B
batmen
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
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
sepia-pub
mael
batmen
Commits
ea5e9492
Commit
ea5e9492
authored
11 months ago
by
Maël Madon
Browse files
Options
Downloads
Patches
Plain Diff
doc: readme on how to build the doc
parent
590ae303
Branches
Branches containing commit
No related tags found
No related merge requests found
Pipeline
#9499
passed
11 months ago
Stage: build-and-test
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+17
-1
17 additions, 1 deletion
README.md
with
17 additions
and
1 deletion
README.md
+
17
−
1
View file @
ea5e9492
...
...
@@ -102,6 +102,22 @@ nix-shell -A test --command "pytest"
For more information about the tests, read the
[
test README
](
test/README.md
)
## Build the documentation
Batmen documentation is hosted on readthedocs: [Batmen doc].
It is automatically built and updated whenever there is a push on Batmen's
`master`
branch.
To build the doc manually, we provide a dedicated nix shell.
From Batmen root directory:
```
shell
cd
docs/
nix-shell
-A
doc
make html
```
The doc is generated inside the folder
`docs/_build`
and can be viewed on the browser by opening the file
`docs/_build/html/index.html`
.
[
Nix
]:
https://nixos.org/nix/
[
Batsim
]:
https://batsim.org/
[
batsched
]:
https://framagit.org/batsim/batsched
\ No newline at end of file
[
batsched
]:
https://framagit.org/batsim/batsched
[
Batmen doc
]:
https://batmen.readthedocs.io/en/latest/
\ No newline at end of file
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