Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
Flatland
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
Model registry
Operate
Environments
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
yoogottamk
Flatland
Commits
89acbaa8
Commit
89acbaa8
authored
5 years ago
by
maljx
Browse files
Options
Downloads
Patches
Plain Diff
added make_docs.py for win10 documentation generation
parent
af0fa935
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
AUTHORS.rst
+1
-0
1 addition, 0 deletions
AUTHORS.rst
README.rst
+10
-1
10 additions, 1 deletion
README.rst
make_docs.py
+32
-0
32 additions, 0 deletions
make_docs.py
with
43 additions
and
1 deletion
AUTHORS.rst
+
1
−
0
View file @
89acbaa8
...
...
@@ -11,6 +11,7 @@ Development
* A Egli <adrian.egli@sbb.ch>
* Mattias Ljungström <ml@mljx.io>
Contributors
------------
...
...
This diff is collapsed.
Click to expand it.
README.rst
+
10
−
1
View file @
89acbaa8
...
...
@@ -21,12 +21,20 @@ Generate Docs
| **TODO**: Mohanty to add atleast a neat outline herefor the contents to the docs here.
.. code-block:: bash
Linux and macOS setup
git clone git@gitlab.aicrowd.com:flatland/flatland.git
cd flatland
pip install -r requirements_dev.txt
make docs
Windows Setup
git clone git@gitlab.aicrowd.com:flatland/flatland.git
cd flatland
pip install -r requirements_dev.txt
python setup.py develop
python make_docs.py
Features
--------
...
...
@@ -36,4 +44,5 @@ Authors
--------
* Sharada Mohanty <mohanty@aicrowd.com>
* Giacomo Spigler <giacomo.spigler@gmail.com>
* Mattias Ljungström <ml@mljx.io>
<please fill yourself in>
\ No newline at end of file
This diff is collapsed.
Click to expand it.
make_docs.py
0 → 100644
+
32
−
0
View file @
89acbaa8
#!/usr/bin/env python
import
os
import
webbrowser
import
subprocess
def
browser
(
pathname
):
try
:
from
urllib
import
pathname2url
except
:
from
urllib.request
import
pathname2url
webbrowser
.
open
(
"
file:
"
+
pathname2url
(
pathname
))
def
remove_exists
(
filename
):
try
:
os
.
remove
(
filename
)
except
FileNotFoundError
:
pass
# clean docs config and html files, and rebuild everything
remove_exists
(
'
docs/flatland.rst
'
)
remove_exists
(
'
docs/modules.rst
'
)
subprocess
.
call
(
'
sphinx-apidoc -o docs/ flatland
'
)
os
.
environ
[
"
SPHINXPROJ
"
]
=
"
flatland
"
os
.
chdir
(
'
docs
'
)
subprocess
.
call
(
'
python -msphinx -M clean . _build
'
)
subprocess
.
call
(
'
python -msphinx -M html . _build
'
)
browser
(
os
.
path
.
abspath
(
'
_build/html/index.html
'
))
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