Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
DuniterPy
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
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
clients
python
DuniterPy
Commits
120e7baa
Commit
120e7baa
authored
6 years ago
by
Vincent Texier
Browse files
Options
Downloads
Patches
Plain Diff
issue
#55
Update README with make docs command
Use Makefile for docs and tests
parent
970aa3a6
No related branches found
No related tags found
No related merge requests found
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
Makefile
+10
-0
10 additions, 0 deletions
Makefile
README.rst
+5
-1
5 additions, 1 deletion
README.rst
with
15 additions
and
1 deletion
Makefile
0 → 100644
+
10
−
0
View file @
120e7baa
.PHONY
:
docs tests
# generate documentation
docs
:
cd
docs
&&
sphinx-apidoc
-o
.
../duniterpy
&&
make html
&&
cd
..
# run tests
tests
:
python
-m
unittest
This diff is collapsed.
Click to expand it.
README.rst
+
5
−
1
View file @
120e7baa
...
@@ -46,7 +46,7 @@ Development
...
@@ -46,7 +46,7 @@ Development
* Add PYTHONPATH env var to your shell containing the path to this repository
* Add PYTHONPATH env var to your shell containing the path to this repository
* Run unit tests with::
* Run unit tests with::
python -m unit
test
make
test
s
* Take a look at examples folder
* Take a look at examples folder
* Run examples from parent folder::
* Run examples from parent folder::
...
@@ -60,6 +60,10 @@ Documentation
...
@@ -60,6 +60,10 @@ Documentation
pip install -r requirements_dev.txt
pip install -r requirements_dev.txt
* Generate documentation::
make docs
* HTML Documentation is generated in docs/_build/html folder.
* HTML Documentation is generated in docs/_build/html folder.
* `Examples <https://git.duniter.org/clients/python/duniterpy/tree/master/examples>`_
* `Examples <https://git.duniter.org/clients/python/duniterpy/tree/master/examples>`_
...
...
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