Comments (2)
I'd like to work on this issue. Any tips on how to go about it?
from docwriter.
Hi @parthskansara, thanks for your interest! Sorry, it took me a while to respond. I will try to briefly explain what the issue is about and what I think should be changed.
The static assets needed to build the FreeType API reference (images, JS, and CSS) are currently part of the FreeType repository here. This directory (docs/markdown) is where the markdown files are built (by docwriter) and are then converted to a website using MkDocs. This means that if we have changes in Docwriter that require a change in those assets, a commit needs to be added to the FreeType repository.
I would prefer that these assets be moved to the docwriter repository, and be shipped with it (as part of the Python package). These assets should then be copied to the markdown directory in the FreeType tree during the generation process (running make refdoc
in the FreeType repository).
Let me know if you have any questions or ideas.
from docwriter.
Related Issues (10)
- Travis CI with FreeType's version HOT 5
- No index.html in generated site. HOT 1
- Incompatible dependency of Markdown between mkdocs-material and mkdocs.
- Consider using Readme as the long description HOT 1
- Consider using setuptools_scm
- Contribution file required HOT 2
- Dependabot couldn't authenticate with https://pypi.python.org/simple/
- refdoc build fails HOT 2
- Style guide issue
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 docwriter.