Comments (4)
@bioinfer You mean multiple sphinx sources? Can you provide a usage example that would need to be supported? (urls.py/settings.py
)
from django-docs.
Thanks for your reply.
Suppose I have two projects, documentation of each project is written in sphinx-doc, I want hosting these documentation on django-docs, like this:
index.html
<ul id="project_list">
<li><a href="url-to-project-1-index">project 1</a></li>
<li><a href="url-to-project-2-index"></a>project 2</li>
</ul>
when I click project 1
, it redirect to project 1's documentation, etc.
from django-docs.
I see, so maybe what you're talking about could be implemented by supporting the following settings structure?
DOCS_DIRS = {
'project1': os.path.join(PROJECT1_PATH, '../docs/_build/html'),
'project2': os.path.join(PROJECT2_PATH, '../docs/_build/html'),
}
Right now it's not supported and could possibly be a feature in the future if it's useful. But at this point, django-docs doesn't really do anything other than serving a static folder with html/css files (presumably generated by sphinx) and optionally manages access rules for it, so you could just symlink multiple build directories of different shinx docs into one place and then use that directory as DOCS_ROOT
I think supporting "multiple projects" is an overkill for this app as it doesn't really know anything about "projects"...
from django-docs.
OK, I see.
from django-docs.
Related Issues (20)
- Fix coverage report
- py-modindex.html" does not exist HOT 1
- Multiple versions HOT 2
- NoReverseMatch HOT 1
- Request object on Index.html HOT 1
- using django-docs with django 2.0 HOT 4
- Update Django-docs on PyPy HOT 2
- ImportError: cannot import name 'login' HOT 1
- pip setup incorrect HOT 1
- i18n_patterns HOT 1
- “/docs/_build/html/index.html” does not exist HOT 1
- django.conf.urls.url() is deprecated in favor of django.urls.re_path() HOT 2
- How to show few doc pages to admin only?
- ImportError: cannot import name 'ugettext' from 'django.utils.translation'
- float(django.get_version()) causes ValueError: could not convert string to float: '3.2.16' HOT 3
- cannot import name 'url' from 'django.conf.urls'
- can I serve multiple _build directories? HOT 1
- Switch from nose to DiscoverRunner or py.test
- Python 3 support HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from django-docs.