Comments (6)
Do you have an error message? If so can you post it too? I believe your problem is just configuring the imports correctly.
from keras-autodoc.
Sure! I get the following warning:
WARNING - A relative path to 'functions_bcn_trees.md' is included in the 'nav' configuration, which is not found in the documentation files
The file is not generated, and yes, I believe you are right, but I have no clue on how to configure imports correctly. Could you please help me with that?
from keras-autodoc.
from keras-autodoc.
Thanks again!
Apologies again, but since I have just landed to python, I am not yet familiar with importing and installing projects. That's what I've done so far:
- create a
/setup.py
file in my root folder. Since I am not familiar with it, I left the default contents generated by Cookiecutter DataScience:
from setuptools import find_packages, setup
setup(
name='src',
packages=find_packages(),
version='0.1.0',
description='Scripts for preparing data improrts to OSM.',
author='Carlos Cámara',
license='MIT',
)
- Run
pip install -e ./
:
Obtaining file:///home/ccamara/www/osm_imports_preparations
Installing collected packages: src
Running setup.py develop for src
Successfully installed src
- Edit autogen.py with the following content:
# content of docs/autogen.py
from keras_autodoc import DocumentationGenerator
from src.features import bcn_trees
pages = {
'api_bcn_trees.md': [
'src.data_download',
'src.data_munging']
}
doc_generator = DocumentationGenerator(pages)
doc_generator.generate('./sources')
- Run
mkdocs serve
, but unfortunately, nofunctions_bcn_trees.md
file is generated:
$ mkdocs serve
INFO - Building documentation...
INFO - Cleaning site directory
WARNING - A relative path to 'functions_bcn_trees.md' is included in the 'nav' configuration, which is not found in the documentation files
[I 191221 14:07:15 server:296] Serving on http://127.0.0.1:8000
[I 191221 14:07:15 handlers:62] Start watching changes
[I 191221 14:07:15 handlers:64] Start detecting changes
[I 191221 14:07:49 watcher:104] Running task: builder (delay: None)
INFO - Building documentation...
What am I missing?
from keras-autodoc.
in pages, try to change src.data_download
by src.features.bcn_trees.data_download
.
Also remember to execute the autogen.py before doing mkdocs serve.
from keras-autodoc.
Oh! thank you! After changing the path in pages and making sure to run autogen.py
before mkdocs serve
(I thought that that command triggered autogen.py, but I was wrong, so thanks for pointing this out), it is working great! Thanks for your great job and for guiding me with this issue! (I have credited you in the repo following the all-contributors guidelines: https://github.com/ccamara/osm_imports_preparations#contributors-)
from keras-autodoc.
Related Issues (18)
- Use class alias HOT 2
- Functions with wrappers showing as having no arguments HOT 1
- *arg, **kwargs not showing in documented function signatures HOT 1
- Docstring of super class doesn't show HOT 1
- Turn example code into pytest tests HOT 3
- Populate the README and write a documentation. HOT 1
- Add source link to methods and functions
- Empty lines between arguments are not rendered correctly. HOT 1
- Make the type hints use aliases instead of full path.
- Display the type hints and default values in the description. HOT 5
- Support for argparse HOT 4
- Can "function" and "class" suffixes in docs headers be removed or become optional? HOT 1
- Support for dataclasses HOT 1
- Support for Enums HOT 1
- [Question] Pinned Black version HOT 4
- Extend the doctoring for the `Args` argument too
- ImportError: cannot import name 'Signature' from 'sphinx.util.inspect' HOT 4
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 keras-autodoc.