Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
E
ensembl-hive
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Locked Files
Issues
0
Issues
0
List
Boards
Labels
Service Desk
Milestones
Iterations
Jira
Jira
Merge Requests
7
Merge Requests
7
Requirements
Requirements
List
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Security & Compliance
Security & Compliance
Dependency List
License Compliance
Operations
Operations
Incidents
Environments
Packages & Registries
Packages & Registries
Package Registry
Container Registry
Analytics
Analytics
CI / CD
Code Review
Insights
Issue
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
ensembl-gh-mirror
ensembl-hive
Commits
38f63c62
Commit
38f63c62
authored
Sep 18, 2020
by
Matthieu Muffato
Committed by
ens-bwalts
Nov 11, 2020
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Use doxypypy on RTD
It handles better Python than doxypy. See
https://github.com/Feneric/doxypypy
parent
1a1cfebe
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
22 additions
and
5 deletions
+22
-5
docs/requirements.txt
docs/requirements.txt
+1
-0
scripts/dev/doxypypy_filter.sh
scripts/dev/doxypypy_filter.sh
+17
-0
scripts/dev/make_doxygen.pl
scripts/dev/make_doxygen.pl
+4
-5
No files found.
docs/requirements.txt
View file @
38f63c62
sphinxcontrib-doxylink==1.3
doxypypy
scripts/dev/doxypypy_filter.sh
0 → 100755
View file @
38f63c62
#!/bin/sh
# Copyright [1999-2015] Wellcome Trust Sanger Institute and the EMBL-European Bioinformatics Institute
# Copyright [2016-2020] EMBL-European Bioinformatics Institute
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
exec
doxypypy
-a
-c
"
$1
"
scripts/dev/make_doxygen.pl
View file @
38f63c62
...
...
@@ -86,10 +86,9 @@ sub generate_docs_doxygen_python {
chomp
$doxy_bin
;
die
"
Cannot run doxygen binary, please make sure it is installed and is in the path.
\n
"
unless
(
-
r
$doxy_bin
);
my
$doxy_filter
=
`
which doxypy
`;
chomp
$doxy_filter
;
die
"
Cannot find the Doxygen Python filter 'doxypy' in the current PATH.
\n
"
unless
-
e
$doxy_filter
;
my
$doxypypy
=
`
which doxypypy
`;
chomp
$doxypypy
;
die
"
Cannot find the Doxygen Python filter 'doxypypy' in the current PATH.
\n
"
unless
-
e
$doxypypy
;
my
@cmds
=
(
"
rm -rf
$doxy_target
/python3
",
...
...
@@ -100,9 +99,9 @@ sub generate_docs_doxygen_python {
"
echo 'OUTPUT_DIRECTORY =
$doxy_target
'
",
"
echo 'STRIP_FROM_PATH =
$ehrd
/wrappers/python3'
",
"
echo 'INPUT =
$ehrd
/wrappers/python3'
",
"
echo 'INPUT_FILTER =
$doxy_filter
'
",
"
echo 'HTML_OUTPUT = python3'
",
"
echo 'FILE_PATTERNS = *.py README.md'
",
"
echo 'FILTER_PATTERNS = *.py=
$ehrd
/scripts/dev/doxypypy_filter.sh'
",
"
echo 'EXTRACT_PRIVATE = YES'
",
"
echo 'EXTRACT_STATIC = YES'
",
"
echo 'CLASS_DIAGRAMS = YES'
",
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment